Struct File

pub struct File { /* private fields */ }

A File.

Implementations

impl File

pub fn new<T>(name: &str, contents: T) -> File

where T: BlobContents,

Create a new File with the given name and contents.

contents can be &str, &[u8], or js_sys::ArrayBuffer.

pub fn new_with_options<T>( name: &str, contents: T, mime_type: Option<&str>, last_modified_time: Option<SystemTime>, ) -> File

where T: BlobContents,

Like File::new, but allows customizing the MIME type (also known as content type or media type), and the last modified time.

std::time::SystemTime is a low level type, use a crate like chrono to work with a more user-friendly representation of time.

Examples

use chrono::prelude::*;
use gloo_file::File;

// Just create a dummy `gloo::file::File` for demonstration purposes.
let example_file = File::new_with_options(
    "motivation.txt",
    "live your best life",
    Some("text/plain"),
    Some(Utc::now().into())
);
assert_eq!(example_file.name(), String::from("motivation.txt"));
assert_eq!(example_file.raw_mime_type(), String::from("text/plain"));

pub fn name(&self) -> String

Gets the file name.

pub fn last_modified_time(&self) -> SystemTime

Gets the time that the file was last modified.

std::time::SystemTime is a low level type, use a crate like chrono to work with more user-friendly representations of time. For example:

use chrono::prelude::*;
use gloo_file::File;

// Just create a dummy `gloo::file::File` for demonstration purposes.
let example_file = File::new("test_file.txt", "<almost empty contents>");
let date: DateTime<Utc> = example_file.last_modified_time().into();

pub fn slice(&self, start: u64, end: u64) -> Self

Create a new File from a sub-part of this File.

Methods from Deref<Target = Blob>

pub fn slice(&self, start: u64, end: u64) -> Self

pub fn size(&self) -> u64

The number of bytes in the Blob/File.

pub fn raw_mime_type(&self) -> String

The raw MIME type (also known as content type or media type) of the File or Blob.

Trait Implementations

impl AsRef<Blob> for File

fn as_ref(&self) -> &Blob

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<File> for File

fn as_ref(&self) -> &File

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for File

fn clone(&self) -> File

Returns a copy 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 Deref for File

type Target = Blob

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<File> for Blob

fn from(file: File) -> Self

Converts to this type from the input type.

impl From<File> for File

fn from(file: File) -> Self

Converts to this type from the input type.

impl From<File> for ObjectUrl

fn from(file: File) -> Self

Converts to this type from the input type.

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 Eq for File

impl StructuralPartialEq for File