Struct FileSource 

pub struct FileSource {
    pub path: String,
    pub source: Option<String>,
    pub access: Option<Time>,
    pub dependencies: Vec<Arc<FileSource>>,
}

File Encapsulation

Fields

path: String

File Path

source: Option<String>

File Source

access: Option<Time>

Last File Access Time

dependencies: Vec<Arc<FileSource>>

An Ordered List of File Dependencies

Implementations

impl FileSource

fn discover_all_file_sources( node_file_source: Arc<FileSource>, visited_nodes: &mut HashSet<String>, ) -> Vec<Arc<FileSource>>

Visit all dependencies and return a list of none duplicate FileSource in order of occurrence.

pub fn fully_flatten( node_file_source: Arc<FileSource>, ) -> (String, Vec<(Arc<FileSource>, Span)>)

Generates a fully flattened source code for the given FileSource and all its dependencies

Examples

Let’s say you have a file, a.txt with two dependencies, b.txt and c.txt, fully_flatten() will generate a source code string with the contents of b.txt and c.txt appended to the end of the contents of a.txt.

Note: This preserves #include statements in the output to maintain correct span positions

pub fn derive_dir(path: &str) -> Option<String>

Derives a File Path’s directory

pub fn localize_file(parent: &str, child: &str) -> Option<String>

Localizes a file path, if path is relative

Trait Implementations

impl Clone for FileSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileSource

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

Formats the value using the given formatter.

impl Default for FileSource

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileSource

impl From<FileSource> for JsValue

where FileSource: Serialize,

fn from(value: FileSource) -> Self

Converts to this type from the input type.

impl FromWasmAbi for FileSource

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for &FileSource

where FileSource: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for FileSource

where FileSource: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for FileSource

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for FileSource

where FileSource: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl Ord for FileSource

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FileSource

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FileSource

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefFromWasmAbi for FileSource

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<FileSource>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Serialize for FileSource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileSource

impl Tsify for FileSource

const DECL: &'static str = "/**\n * File Encapsulation\n */\nexport interface FileSource {\n /**\n * File Path\n */\n path: string;\n /**\n * File Source\n */\n source: string | undefined;\n /**\n * Last File Access Time\n */\n access: number | undefined;\n /**\n * An Ordered List of File Dependencies\n */\n dependencies: FileSource[];\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl VectorFromWasmAbi for FileSource

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for FileSource

where FileSource: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for FileSource

fn describe()

impl WasmDescribeVector for FileSource

fn describe_vector()

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 88 bytes