Skip to main content

WalkFsCapture

Struct WalkFsCapture 

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

Captures a directory tree into a BlobStore and emits a single fs.tree.v1 blob describing the structure.

Concurrency: file content-addressing runs on a rayon thread pool. Walk itself is single-threaded (walkdir) — we sort all entries first so the emitted manifest is byte-identical across runs over the same tree.

Implementations§

Source§

impl WalkFsCapture

Source

pub fn new(root: impl AsRef<Path>) -> Self

Capture the directory rooted at root.

Source

pub fn new_without_default_ignores(root: impl AsRef<Path>) -> Self

Build a capturer that does NOT carry the v1.0.13 default-extra ignore set (__pycache__, .pytest_cache, *.pyc, …). Operators who want byte-for-byte capture of every file in the source tree (rare; CI auditing the set itself; building a registry mirror) call this. Default callers should use WalkFsCapture::new which has the safe set.

Source

pub fn use_apfs_clone(self, enable: bool) -> Self

Toggle the macOS APFS clone fast-path. When enabled and the source is on APFS, we clonefile(2)-clone the directory into a temp dir first (O(1) per the APFS docs) and walk the clone — giving a stable view without pausing the agent. Falls back to a direct walk on other filesystems / OSes. Off by default in v1; opt in for production.

Follow symlinks during walk. Off by default — we capture symlinks as symlinks, not as the targets they happen to point at.

Source

pub fn ignore(self, fragment: impl Into<String>) -> Self

Add a path-fragment OR glob pattern to the ignore list.

  • Plain entries (target, __pycache__, .git/objects) are matched as path-component sequences, exactly as before.
  • Glob entries (anything containing *, ?, [) are matched against the relative path via globset::Glob. Common patterns: *.pyc, *.log, **/build/**.

v1.0.13 added glob support; segment-match semantics for plain entries are unchanged.

Source

pub fn ignore_from(self, path: impl AsRef<Path>) -> Result<Self>

Read a .gitignore/.pfignore-style file and apply each non-comment, non-empty line as an ignore entry. Lines ending with / have the slash stripped (gitignore directory marker). Lines starting with ! (gitignore negation) are skipped with a tracing::warn! — this is a v1.0.13 limitation; full gitignore semantics with negation arrive when an operator hits the use case.

Returns Ok(self) even if the file doesn’t exist (so .ignore_from(".pfignore") is safe to chain unconditionally). Returns the underlying io::Error only if the file exists but can’t be read (permissions, etc.).

Source

pub fn capture(&self, blobs: &Arc<dyn BlobStore>) -> Result<Digest256>

Run the capture. Returns the digest of the fs.tree.v1 blob.

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> 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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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