Struct File 

pub struct File {
    pub name: String,
    pub content: String,
    pub encoding: String,
}

A file that contains source code to be executed.

Fields

name: String

content: String

Required The content of the file.

encoding: String

The encoding of the file. Defaults to “utf8”.

Implementations

impl File

pub fn new(name: &str, content: &str, encoding: &str) -> Self

Creates a new File.

Arguments

• name - The name to use.
• content - The content to use.
• encoding - The encoding to use. Must be one of “utf8”, “hex”, or “base64”.

Returns

• File - The new File.

Example

let file = piston_rs::File::new(
    "script.sh",
    "ZWNobyBIZWxsbywgV29ybGQh",
    "base64",
);

assert!(file.content.contains("ZWNobyBIZWxsbywgV29ybGQh"));
assert_eq!(file.name, "script.sh".to_string());
assert_eq!(file.encoding, "base64".to_string());

pub fn load_from(path: &str) -> Result<Self, LoadError>

Creates a new File from an existing file on disk.

Arguments

• path - The path to the file.

Returns

• File - The new File.

Example

let file = piston_rs::File::load_from("src/lib.rs").unwrap();

assert!(file.content.contains("pub fn load_from"));
assert_eq!(file.name, "lib.rs".to_string());
assert_eq!(file.encoding, "utf8".to_string());

pub fn set_content(self, content: &str) -> Self

Sets the content of the file.

Arguments

• content - The content to use.

Returns

• Self - For chained method calls.

Example

let file = piston_rs::File::default()
    .set_content("print(\"Hello, world!\")");

assert_eq!(file.content, "print(\"Hello, world!\")".to_string());

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

Sets the content of the file to the contents of an existing file on disk.

Arguments

• path - The path to the file.

Returns

• Self - For chained method calls.

Example

let file = piston_rs::File::default()
    .load_content_from("src/lib.rs");

assert!(file.is_ok());
assert!(file.unwrap().content.contains("pub fn load_content_from"));

pub fn set_name(self, name: &str) -> Self

Sets the name of the file.

Arguments

• name - The name to use.

Returns

• Self - For chained method calls.

Example

let file = piston_rs::File::default()
    .set_name("__main__.py");

assert_eq!(file.name, "__main__.py".to_string());

pub fn set_encoding(self, encoding: &str) -> Self

Sets the encoding of the file.

Arguments

• encoding - The encoding to use. Must be one of “utf8”, “hex”, or “base64”.

Returns

• Self - For chained method calls.

Example

let file = piston_rs::File::default()
    .set_encoding("hex");

assert_eq!(file.encoding, "hex".to_string());

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> Self

Creates an unnamed new File with utf8 encoding and no content.

Returns

• File - The new blank File.

Example

let file = piston_rs::File::default();

assert_eq!(file.name, String::new());
assert_eq!(file.content, String::new());
assert_eq!(file.encoding, "utf8".to_string());

impl<'de> Deserialize<'de> for File

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for File

fn eq(&self, other: &File) -> 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 File

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for File

impl StructuralPartialEq for File