Skip to main content

SourceBundleRequest

Struct SourceBundleRequest 

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

Local request used to select source for a snapshot.

Roots are local paths. Additional inputs are portable paths relative to the workspace and cannot escape it.

Implementations§

Source§

impl SourceBundleRequest

Source

pub fn new( workspace_root: impl Into<Utf8PathBuf>, project_root: impl Into<Utf8PathBuf>, ) -> Self

Create a request for one project contained by a workspace.

Source

pub fn include_workspace_path(self, path: impl Into<Utf8PathBuf>) -> Self

Add an allowlisted workspace-relative file or directory.

Source

pub fn exclude_workspace_path(self, path: impl Into<Utf8PathBuf>) -> Self

Exclude one portable workspace-relative path and all descendants.

Exclusions take precedence over the project root, built-in workspace inputs, explicit includes, and .ferryignore. The workspace root (.) is not a valid exclusion. Built-in sensitive exclusions remain non-overridable and are audited separately.

Source

pub fn with_executable_mode( self, path: impl Into<Utf8PathBuf>, executable: bool, ) -> Self

Supply portable executable-mode metadata for one workspace-relative file.

The path must be selected into the final manifest. On non-Unix hosts the supplied value is authoritative because filesystem mode bits are not available. On Unix, a true value adds executable intent while a live filesystem executable bit remains authoritative and is never cleared.

Source

pub fn with_max_traversal_entries(self, maximum: usize) -> Self

Apply a stricter combined traversal-entry limit than the defensive default.

Values above MAX_SOURCE_TRAVERSAL_ENTRIES are rejected during planning rather than weakening the global defensive ceiling. The one budget counts components in explicit request paths, filesystem directory entries read during selection, and components in final manifest paths.

Source

pub fn with_limits(self, limits: SourceLimits) -> Self

Replace the default resource limits.

Source

pub fn workspace_root(&self) -> &Utf8Path

Return the configured workspace root.

Source

pub fn project_root(&self) -> &Utf8Path

Return the configured project root.

Source

pub fn workspace_inputs(&self) -> &[Utf8PathBuf]

Return caller-selected workspace-relative inputs.

Source

pub fn workspace_exclusions(&self) -> &[Utf8PathBuf]

Return caller-selected workspace-relative exclusions.

Source

pub fn executable_modes(&self) -> &[(Utf8PathBuf, bool)]

Return caller-supplied portable executable-mode metadata.

Source

pub fn max_traversal_entries(&self) -> usize

Return the configured combined traversal-entry limit.

The budget covers request path components, filesystem directory entries, and every component of every final manifest path.

Source

pub fn limits(&self) -> SourceLimits

Return the configured resource limits.

Trait Implementations§

Source§

impl Clone for SourceBundleRequest

Source§

fn clone(&self) -> Self

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 SourceBundleRequest

Source§

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

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

impl Eq for SourceBundleRequest

Source§

impl PartialEq for SourceBundleRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SourceBundleRequest

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<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, 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 = !

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.