Skip to main content

SourceReader

Struct SourceReader 

Source
pub struct SourceReader { /* private fields */ }
Expand description

A detached reader over the server’s byte sources, for code that needs raw bytes away from the ECS: the bundles, then every registered AssetSource, then the filesystem. Kind-agnostic - no decoder runs and no cache is touched - so any plugin or runtime module that loads its own data (media files, archives, anything it ships with the app) reads through the same chain the asset pipeline uses instead of the raw filesystem.

Get one from crate::AssetServer::source_reader. The reader is a cheap snapshot: Send + Sync, safe to move to another thread, and free to block there (an archive read is a copy, a filesystem read is I/O). It does not follow later registrations - a source or bundle registered after the snapshot is invisible to it - so take a fresh reader per request rather than holding one for the app’s lifetime.

The reader resolves the path it is given. Callers keep the same conventions the rest of the pipeline uses: resolve app-relative paths first (lumen_core::app_paths::resolve), and pass lumen://app/... URIs through untouched - the bundle source claims those itself.

Implementations§

Source§

impl SourceReader

Source

pub fn read(&self, path: &Path) -> Result<Vec<u8>>

The bytes for path: the first source that claims it, else the filesystem. A path nothing holds is the filesystem’s NotFound error, so a missing bundled entry and a missing file report the same way.

Trait Implementations§

Source§

impl Clone for SourceReader

Source§

fn clone(&self) -> SourceReader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ConditionalSend for T
where T: Send,