Skip to main content

IndexBuilder

Struct IndexBuilder 

Source
pub struct IndexBuilder<'a> { /* private fields */ }
Expand description

Recursive scanner that turns a project’s assets/ directory into an AssetMetadata list ready for the VFS.

See module documentation for determinism and UUID stability guarantees.

Implementations§

Source§

impl<'a> IndexBuilder<'a>

Source

pub fn new(assets_root: &'a Path) -> Self

Creates a new builder rooted at assets_root.

assets_root must be the assets directory of a project, not the project root — the relative paths recorded in AssetMetadata (and hence the UUIDs) are computed relative to it.

Without Self::with_registry, UUIDs are the path-derived new_v5 default (the pre-registry behaviour).

Source

pub fn with_registry(self, registry: &'a AssetIdRegistry) -> Self

Resolves each asset’s UUID through registry (frozen identities win; unfrozen paths still fall back to new_v5). Supply the same registry in dev (editor VFS) and release (pack builder) so UUIDs match by construction.

Source

pub fn build_metadata(&self) -> Result<Vec<AssetMetadata>>

Walks the assets root and produces a sorted, deterministic Vec<AssetMetadata>.

Returns an empty vector if assets_root doesn’t exist — the editor tolerates fresh projects whose assets/ directory hasn’t been populated yet.

Source

pub fn build_index_bytes(&self) -> Result<Vec<u8>>

Convenience: builds metadata and bincode-encodes it into the byte vector that crate::vfs::VirtualFileSystem::new expects.

Auto Trait Implementations§

§

impl<'a> Freeze for IndexBuilder<'a>

§

impl<'a> RefUnwindSafe for IndexBuilder<'a>

§

impl<'a> Send for IndexBuilder<'a>

§

impl<'a> Sync for IndexBuilder<'a>

§

impl<'a> Unpin for IndexBuilder<'a>

§

impl<'a> UnsafeUnpin for IndexBuilder<'a>

§

impl<'a> UnwindSafe for IndexBuilder<'a>

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
§

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

§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,