Struct File 

pub struct File {
    pub asset_id: AssetId,
    pub path: String,
    pub kind: Option<FileKind>,
    pub locator: Option<PayloadLocator>,
}

References a source file by path.

For supported kinds the build compiles the file into the world (an .obj becomes mesh data); other kinds are path-only references.

Fields

asset_id: AssetId

Assigned by the loader; not authored.

path: String

Path to the source file, relative to the world.

kind: Option<FileKind>

Content category, derived from the extension when not authored.

locator: Option<PayloadLocator>

Injected at load time for kinds that produce a compiled blob (e.g. obj → mesh payload).

Implementations

impl File

pub fn bake(args: FileArgs) -> Self

Translate the authored args into the runtime file reference: derive kind from the path extension when unset. Run by cook at build time (the baked blob record carries the result).

Trait Implementations

impl Component for File

const NAME: &'static str = "File"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<Self, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for File

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<Self>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Self>

Mutably borrow this type’s column out of the storage.

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<File> for ComponentAsset

fn from(c: File) -> Self

Converts to this type from the input type.

impl RuntimeComponent for File

impl Serialize for File

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.