Struct BufferFile 

pub struct BufferFile { /* private fields */ }

Buffer metadata for an optional file on disk.

Implementations

impl BufferFile

pub const fn scratch(saved_revision: u64) -> Self

Creates scratch buffer metadata with no backing file.

pub const fn backed_by(path: PathBuf, saved_revision: u64) -> Self

Creates file-backed buffer metadata.

pub const fn path(&self) -> Option<&PathBuf>

Returns the backing path, if one exists.

pub const fn is_modified(&self, stream: &TextByteStream) -> bool

Returns whether the current stream has changes not known to be saved.

pub fn write( &mut self, stream: &TextByteStream, config: &FilesystemConfig, ) -> Result<BufferWriteReport, BufferWriteError>

Writes the stream to the backing path and updates the saved revision.

Errors

Returns BufferWriteError::NoFileName when the buffer is scratch, or BufferWriteError::Io when the write fails.

Trait Implementations

impl Clone for BufferFile

fn clone(&self) -> BufferFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for BufferFile

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for BufferFile

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

Formats the value using the given formatter.

impl Default for BufferFile

fn default() -> BufferFile

Returns the “default value” for a type.

impl PartialEq for BufferFile

fn eq(&self, other: &BufferFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BufferFile

impl StructuralPartialEq for BufferFile