Skip to main content

FileNameStore

Struct FileNameStore 

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

The CLI’s registry: one JSON file per name in a directory, owner-only on Unix.

Implementations§

Source§

impl FileNameStore

Source

pub fn new(dir: impl Into<PathBuf>) -> FileNameStore

A store over the directory that holds the name files themselves.

Source

pub fn in_state_root(state_root: &Path) -> FileNameStore

The registry under state_root/names — where the CLI keeps it.

A subdirectory rather than the state root because the run ledger’s *.json glob must never read a name record as a ledger.

Source

pub fn default_location(env: &dyn Fn(&str) -> Option<String>) -> FileNameStore

The registry the CLI would use in this environment.

If no absolute home can be resolved, the returned store refuses every storage operation with a precondition error and its directory is empty.

Source

pub fn dir(&self) -> &Path

The directory holding the name files.

Source

pub fn path_of(&self, name: &str) -> PathBuf

Where name’s record lives, whether or not one is registered.

Trait Implementations§

Source§

impl Clone for FileNameStore

Source§

fn clone(&self) -> FileNameStore

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
Source§

impl Debug for FileNameStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl NameStore for FileNameStore

Source§

fn get(&self, name: &str) -> Result<Option<NameRecord>, Error>

A file that exists but does not parse is an error, not a free name: a torn record is what a killed write leaves, and treating it as free would let a second VM claim a name whose first holder may still be billing.

Source§

fn list(&self) -> Result<Vec<NameRecord>, Error>

Skips files that are not records: a torn file is reported by NameStore::get for its own name, and must not make every other name unlistable.

Source§

fn put(&self, record: &NameRecord) -> Result<(), Error>

Writes record under its name, replacing any earlier record.
Source§

fn delete(&self, name: &str) -> Result<bool, Error>

Removes name, answering whether a record was there.
Source§

fn describe(&self) -> String

Where this store keeps names, for error messages.
Source§

fn release_by_vm(&self, microvm_id: &str) -> Result<Vec<String>, Error>

Removes every name registered to microvm_id and returns them, sorted. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

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
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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