Struct include_dir::File

pub struct File<'a> { /* private fields */ }

A file with its contents stored in a &'static [u8].

Implementations

impl<'a> File<'a>

pub const fn new(path: &'a str, contents: &'a [u8]) -> Self

Create a new File.

pub fn path(&self) -> &'a Path

The full path for this File, relative to the directory passed to crate::include_dir!().

pub fn contents(&self) -> &[u8]

The file’s raw contents.

pub fn contents_utf8(&self) -> Option<&str>

The file’s contents interpreted as a string.

impl<'a> File<'a>

pub const fn with_metadata(self, metadata: Metadata) -> Self

Set the [Metadata] associated with a File.

pub fn metadata(&self) -> Option<&Metadata>

Get the File’s [Metadata], if available.

Trait Implementations

impl<'a> Clone for File<'a>

fn clone(&self) -> File<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for File<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<File<'a>> for File<'a>

fn eq(&self, other: &File<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for File<'a>

impl<'a> StructuralEq for File<'a>

impl<'a> StructuralPartialEq for File<'a>