Struct FileSystemPath 

pub struct FileSystemPath {
    pub fs: ResolvedVc<Box<dyn FileSystem>>,
    pub path: RcStr,
}

Fields

fs: ResolvedVc<Box<dyn FileSystem>>

path: RcStr

Implementations

impl FileSystemPath

pub fn cell(self) -> Vc<Self>

Places a value in a cell of the current task.

Cell is selected based on the value type and call order of cell.

pub fn resolved_cell(self) -> ResolvedVc<Self>

Places a value in a cell of the current task. Returns a [ResolvedVc][turbo_tasks::ResolvedVc].

Cell is selected based on the value type and call order of cell.

impl FileSystemPath

pub fn value_to_string(&self) -> Vc<RcStr>

Mimics ValueToString::to_string.

impl FileSystemPath

pub fn is_inside_ref(&self, other: &FileSystemPath) -> bool

pub fn is_inside_or_equal_ref(&self, other: &FileSystemPath) -> bool

pub fn is_root(&self) -> bool

pub fn is_in_node_modules(&self) -> bool

pub fn get_path_to<'a>(&self, inner: &'a FileSystemPath) -> Option<&'a str>

Returns the path of inner relative to self.

Note: this method always strips the leading / from the result.

pub fn get_relative_path_to(&self, other: &FileSystemPath) -> Option<RcStr>

pub fn file_name(&self) -> &str

Returns the final component of the FileSystemPath, or an empty string for the root path.

pub fn has_extension(&self, extension: &str) -> bool

Returns true if this path has the given extension

slightly faster than self.extension_ref() == Some(extension) as we can simply match a suffix

pub fn extension_ref(&self) -> Option<&str>

Returns the extension (without a leading .)

impl FileSystemPath

pub fn join(&self, path: &str) -> Result<Self>

Adds a subpath to the current path. The /-separate path argument might contain “..” or “.” segments, but it must not leave the root of the filesystem.

pub fn append(&self, path: &str) -> Result<Self>

Adds a suffix to the filename. [path] must not contain /.

pub fn append_to_stem(&self, appending: &str) -> Result<Self>

Adds a suffix to the basename of the filename. [appending] must not contain /. Extension will stay intact.

pub fn try_join(&self, path: &str) -> Option<FileSystemPath>

Similar to FileSystemPath::join, but returns an Option that will be None when the joined path would leave the filesystem root.

pub fn try_join_inside(&self, path: &str) -> Option<FileSystemPath>

Similar to FileSystemPath::try_join, but returns None when the new path would leave the current path (not just the filesystem root). This is useful for preventing access outside of a directory.

pub fn read_glob(&self, glob: Vc<Glob>) -> Vc<ReadGlobResult>

DETERMINISM: Result is in random order. Either sort result or do not depend on the order.

pub fn track_glob( &self, glob: Vc<Glob>, include_dot_files: bool, ) -> Vc<Completion>

pub fn root(&self) -> Vc<Self>

impl FileSystemPath

pub fn fs(&self) -> Vc<Box<dyn FileSystem>>

pub fn extension(&self) -> &str

pub fn is_inside(&self, other: &FileSystemPath) -> bool

pub fn is_inside_or_equal(&self, other: &FileSystemPath) -> bool

pub fn with_extension(&self, extension: &str) -> FileSystemPath

Creates a new FileSystemPath like self but with the given extension.

pub fn file_stem(&self) -> Option<&str>

Extracts the stem (non-extension) portion of self.file_name.

The stem is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The entire file name if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name before the final .

impl FileSystemPath

pub fn read(&self) -> Vc<FileContent>

pub fn read_link(&self) -> Vc<LinkContent>

pub fn read_json(&self) -> Vc<FileJsonContent>

pub fn read_json5(&self) -> Vc<FileJsonContent>

pub fn raw_read_dir(&self) -> Vc<RawDirectoryContent>

Reads content of a directory.

DETERMINISM: Result is in random order. Either sort result or do not depend on the order.

pub fn write(&self, content: Vc<FileContent>) -> Vc<()>

pub fn write_symbolic_link_dir(&self, target: Vc<LinkContent>) -> Vc<()>

Creates a symbolic link to a directory on *nix platforms, or a directory junction point on Windows.

Windows supports symbolic links, but they can require elevated privileges if “developer mode” is not enabled, so we can’t safely use them. Using junction points matches the behavior of pnpm.

This only supports directories because Windows junction points are incompatible with files. To ensure compatibility, this will return an error if the target is a file, even on platforms with full symlink support.

We intentionally do not provide an API for symlinking a file, as we cannot support that on all Windows configurations.

pub fn metadata(&self) -> Vc<FileMeta>

pub async fn realpath(&self) -> Result<FileSystemPath>

pub fn rebase( fs_path: FileSystemPath, old_base: FileSystemPath, new_base: FileSystemPath, ) -> Vc<FileSystemPath>

impl FileSystemPath

pub fn read_dir(&self) -> Vc<DirectoryContent>

Reads content of a directory.

DETERMINISM: Result is in random order. Either sort result or do not depend on the order.

pub fn parent(&self) -> FileSystemPath

pub fn get_type(&self) -> Vc<FileSystemEntryType>

pub fn realpath_with_links(&self) -> Vc<RealPathResult>

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for FileSystemPath

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for FileSystemPath

fn clone(&self) -> FileSystemPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileSystemPath

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for FileSystemPath

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Display for FileSystemPath

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

Formats the value using the given formatter.

impl Encode for FileSystemPath

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Hash for FileSystemPath

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 FileSystemPath

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ShrinkToFit for FileSystemPath

fn shrink_to_fit(&mut self)

impl TaskInput for FileSystemPath

fn is_resolved(&self) -> bool

fn is_transient(&self) -> bool

fn resolve_input(&self) -> impl Future<Output = Result<Self>> + Send + '_

impl TraceRawVcs for FileSystemPath

fn trace_raw_vcs(&self, __context__: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl ValueDebug for FileSystemPath

fn dbg(self: Vc<Self>) -> Vc<ValueDebugString>

fn dbg_depth(self: Vc<Self>, depth: usize) -> Vc<ValueDebugString>

Like dbg, but with a depth limit.

impl ValueDebugFormat for FileSystemPath

fn value_debug_format<'a>(&'a self, depth: usize) -> ValueDebugFormatString<'a>

impl ValueToString for FileSystemPath

fn to_string(self: Vc<Self>) -> Vc<RcStr>

impl VcValueType for FileSystemPath

type Read = VcDefaultRead<FileSystemPath>

How to read the value.

type CellMode = VcCellCompareMode<FileSystemPath>

How to update cells of this value type.

fn get_value_type_id() -> ValueTypeId

Returns the type id of the value type.

fn has_serialization() -> bool

impl Eq for FileSystemPath

impl NonLocalValue for FileSystemPath

impl StructuralPartialEq for FileSystemPath

impl Upcast<Box<dyn ValueDebug>> for FileSystemPath

impl Upcast<Box<dyn ValueToString>> for FileSystemPath

impl UpcastStrict<Box<dyn ValueDebug>> for FileSystemPath

impl UpcastStrict<Box<dyn ValueToString>> for FileSystemPath