Struct lib_gistit::file::File

pub struct File { /* fields omitted */ }

Represents a gistit file handler and some extra data

Implementations

impl File

pub async fn from_path(path: &Path) -> Result<Self>

Opens a file from the given path and returns a File handler.

Errors

Fails with IoError if the file can’t be opened, which probably means the file doesn’t exist, path is invalid, or file handler is blocked.

pub async fn from_bytes_encoded(bytes: &[u8], name: &str) -> Result<Self>

Creates a new file in your system temp with a random name and writes provided bytes into it. Returns the new File handler

Errors

Fails with IoError if the file can’t be created for some reason. Also if it can’t be written to.

pub async fn from_bytes(decoded_bytes: &[u8]) -> Result<Self>

Same as Self::from_bytes_encoded but doesn’t expect encoded bytes

Errors

Fails with IoError if the file can’t be created for some reason. Also if it can’t be written to.

pub async fn save_as(&self, file_path: &Path) -> Result<()>

Creates/writes the contents as string to the given file path.

Errors

Fails with IoError if the file can’t be written to.

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

Set the file name, useful when creating a File using Self::from_bytes. if the File was created using Self::from_path it will use the provided file name.

pub fn name(&self) -> String

Returns the file name

pub fn lang(&self) -> &str

Returns the programming language that maps to this file extension

pub async fn size(&self) -> u64

Returns the file size in bytes, not encoded.

pub async fn into_encrypted(self, secret: &str) -> Result<EncryptedFile>

Consumes the File encrypting it and returning a new instance of EncryptedFile

Errors

Fails with EncryptionError if something goes wrong during the encryption process. This includes unexpected sizes of the nonce, hashed key. Will also error out if the provided key and nonce is incorrect.

pub async fn check_consume(self) -> Result<Self>

Perform needed checks concurrently, consumes Self and return.

Errors

Fails with FileError if user input isn’t valid

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.

impl FileReady for File

fn inner<'async_trait>(
    self: Box<Self>
) -> Pin<Box<dyn Future<Output = Option<Box<Self>>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Returns a reference to the original File handler if any.

fn data(&self) -> &[u8]

Returns a reference to the underlying data. Can be encrypted depending on the source

fn to_encoded_data(&self) -> EncodedFileData

Converts Self into the sendable form of the data