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 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 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 extension_ref(&self) -> Option<&str>

impl FileSystemPath

pub fn join(self: Vc<Self>, path: RcStr) -> Vc<Self>

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

pub fn append(self: Vc<Self>, path: RcStr) -> Vc<Self>

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

pub fn append_to_stem(self: Vc<Self>, appending: RcStr) -> Vc<Self>

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

pub fn try_join(self: Vc<Self>, path: RcStr) -> Vc<FileSystemPathOption>

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: Vc<Self>, path: RcStr) -> Vc<FileSystemPathOption>

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

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

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

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

pub fn extension(self: Vc<Self>) -> Vc<RcStr>

pub fn is_inside(self: Vc<Self>, other: Vc<FileSystemPath>) -> Vc<bool>

pub fn is_inside_or_equal(self: Vc<Self>, other: Vc<FileSystemPath>) -> Vc<bool>

pub fn with_extension(self: Vc<Self>, extension: RcStr) -> Vc<FileSystemPath>

Creates a new [Vc<FileSystemPath>] like self but with the given extension.

pub fn file_stem(self: Vc<Self>) -> Vc<Option<RcStr>>

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<Self>) -> Vc<FileContent>

pub fn read_link(self: Vc<Self>) -> Vc<LinkContent>

pub fn read_json(self: Vc<Self>) -> Vc<FileJsonContent>

pub fn read_json5(self: Vc<Self>) -> Vc<FileJsonContent>

pub fn raw_read_dir(self: Vc<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: Vc<Self>, content: Vc<FileContent>) -> Vc<()>

pub fn write_link(self: Vc<Self>, target: Vc<LinkContent>) -> Vc<()>

pub fn metadata(self: Vc<Self>) -> Vc<FileMeta>

pub fn realpath(self: Vc<Self>) -> Vc<FileSystemPath>

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

impl FileSystemPath

pub fn read_dir(self: Vc<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: Vc<Self>) -> Vc<FileSystemPath>

pub fn get_type(self: Vc<Self>) -> Vc<FileSystemEntryType>

pub fn realpath_with_links(self: Vc<Self>) -> Vc<RealPathResult>

Trait Implementations

impl Clone for FileSystemPath

fn clone(&self) -> FileSystemPath

Returns a copy 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<'de> Deserialize<'de> for FileSystemPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FileSystemPath

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

Formats the value using the given formatter.

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 Serialize for FileSystemPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShrinkToFit for FileSystemPath

fn shrink_to_fit(&mut self)

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 = VcCellSharedMode<FileSystemPath>

How to update cells of this value type.

fn get_value_type_id() -> ValueTypeId

Returns the type id of the value type.

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