Skip to main content

FileIdMap

Struct FileIdMap 

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

Bidirectional mapping between FileId and the current path of each tracked file (§5.8).

Invariants maintained by all mutating methods:

  • Every FileId maps to exactly one path.
  • Every path maps to exactly one FileId.
  • The two maps are always consistent with each other.

These invariants guarantee O(1) lookup in both directions.

Implementations§

Source§

impl FileIdMap

Source

pub const fn new() -> Self

Create an empty map.

Source

pub fn track_new(&mut self, path: PathBuf) -> Result<FileId, FileIdMapError>

Track a newly created file.

Assigns a fresh random FileId to path and returns it.

§Errors

Returns FileIdMapError::PathAlreadyTracked if path is already tracked. A file must be deleted before it can be re-created at the same path.

Source

pub fn track_rename( &mut self, old_path: &Path, new_path: PathBuf, ) -> Result<FileId, FileIdMapError>

Track a file rename: old_pathnew_path.

The FileId is preserved — only the path mapping changes.

§Errors
Source

pub fn track_copy( &mut self, src_path: &Path, dst_path: PathBuf, ) -> Result<FileId, FileIdMapError>

Track a file copy: create dst_path as a copy of src_path.

Assigns a new random FileId to the copy. The source file keeps its original identity. This is explicit, not inferred from content similarity.

§Errors
Source

pub fn track_delete(&mut self, path: &Path) -> Result<FileId, FileIdMapError>

Track a file deletion.

Removes both mappings. Returns the FileId that was assigned to the deleted file.

§Errors

Returns FileIdMapError::PathNotTracked if path is not tracked.

Source

pub fn id_for_path(&self, path: &Path) -> Option<FileId>

Look up the FileId for a given path. Returns None if untracked.

Source

pub fn path_for_id(&self, id: FileId) -> Option<&Path>

Look up the current path for a given FileId. Returns None if not tracked (file was deleted or never registered).

Source

pub fn contains_path(&self, path: &Path) -> bool

Return true if path is currently tracked.

Source

pub fn contains_id(&self, id: FileId) -> bool

Return true if id is currently tracked.

Source

pub fn len(&self) -> usize

Return the number of tracked files.

Source

pub fn is_empty(&self) -> bool

Return true if no files are tracked.

Source

pub fn iter(&self) -> impl Iterator<Item = (&Path, FileId)>

Iterate over all (path, FileId) entries in sorted path order.

Source

pub fn load(path: &Path) -> Result<Self, FileIdMapError>

Load the map from a .manifold/fileids JSON file.

Returns an empty map if the file does not exist (first run).

§Errors

Returns FileIdMapError::Io on I/O failure (other than not-found), or FileIdMapError::Json on JSON parse failure.

Source

pub fn save(&self, path: &Path) -> Result<(), FileIdMapError>

Save the map to a .manifold/fileids JSON file.

Writes are atomic: content is first written to <path>.tmp then renamed over the destination. This prevents a crash mid-write from leaving a corrupt file.

Parent directories are created if they don’t exist.

§Errors

Returns FileIdMapError::Io on I/O failure, or FileIdMapError::Json on serialization failure.

Trait Implementations§

Source§

impl Clone for FileIdMap

Source§

fn clone(&self) -> FileIdMap

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileIdMap

Source§

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

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

impl Default for FileIdMap

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for FileIdMap

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for FileIdMap

Source§

impl StructuralPartialEq for FileIdMap

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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