Struct FileRoot 

pub struct FileRoot(/* private fields */);

A root path for files tracked by the database.

We currently create roots for:

• static module resolution paths
• the project root

File roots determine the durability of files and directories.

Implementations

impl FileRoot

pub fn ingredient(db: &dyn Database) -> &IngredientImpl<Self>

pub fn ingredient_mut( zalsa_mut: &mut Zalsa, ) -> (&mut IngredientImpl<Self>, &mut Runtime)

impl FileRoot

pub fn new<Db_>( db: &Db_, path: Box<SystemPath>, kind_at_time_of_creation: FileRootKind, ) -> Self

where Db_: ?Sized + Database,

pub fn builder( path: Box<SystemPath>, kind_at_time_of_creation: FileRootKind, ) -> <Self as HasBuilder>::Builder

pub fn path<'db, Db_>( self, db: &'db Db_, ) -> &'db <Box<SystemPath> as Deref>::Target

where Db_: ?Sized + Database,

The path of a root is guaranteed to never change.

pub fn kind_at_time_of_creation<'db, Db_>(self, db: &'db Db_) -> FileRootKind

where Db_: ?Sized + Database,

The kind of the root at the time of its creation.

pub fn set_path<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Box<SystemPath>>

where Db_: ?Sized + Database,

pub fn set_kind_at_time_of_creation<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = FileRootKind>

where Db_: ?Sized + Database,

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'__trivial_bounds> Box<SystemPath>: Debug, for<'__trivial_bounds> FileRootKind: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

Trait Implementations

impl AsId for FileRoot

fn as_id(&self) -> Id

impl Clone for FileRoot

fn clone(&self) -> FileRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for FileRoot

const LOCATION: Location

const DEBUG_NAME: &'static str = "FileRoot"

const FIELD_DEBUG_NAMES: &'static [&'static str]

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Singleton = NotSingleton

The singleton state for this input if any.

type Struct = FileRoot

The input struct (which wraps an Id)

type Fields = (Box<SystemPath>, FileRootKind)

A (possibly empty) tuple of the fields for this struct.

type Revisions = [Revision; 2]

type Durabilities = [Durability; 2]

fn heap_size(value: &Self::Fields) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

fn serialize<S: Serializer>( fields: &Self::Fields, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

fn deserialize<'de, D: Deserializer<'de>>( deserializer: D, ) -> Result<Self::Fields, D::Error>

Deserialize the fields using serde.

impl Copy for FileRoot

impl Debug for FileRoot

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

Formats the value using the given formatter.

impl Eq for FileRoot

impl FromId for FileRoot

fn from_id(id: Id) -> Self

impl HasBuilder for FileRoot

type Builder = Builder_

impl HasJar for FileRoot

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<FileRoot>

The [Jar] associated with this ingredient.

impl Hash for FileRoot

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileRoot

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

Equality operator ==.

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

Inequality operator !=.

impl SalsaStructInDb for FileRoot

const LEAF_TYPE_IDS: &'static [ConstTypeId]

The type IDs of all concrete (leaf) salsa struct types that this type can contain.

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl SalsaValue for FileRoot

impl StructuralPartialEq for FileRoot