Struct File

pub struct File(/* private fields */);

A null-terminated string that always maps to the 128 bytes assigned to it in Message.

You can get the string value back out with to_string():

let path: CString = file.to_string();

Implementations

impl File

pub const EMPTY: Self

A File that contains all zero bytes.

This is more performant than File::new(c"")

pub fn new(path: &CStr) -> Result<Self>

Construct a valid file field. path must not be more than 128 bytes. The last byte of which must be 0x00 (null-terminated).

pub fn from_slice_unchecked(path: &[u8]) -> Self

Converts an array slice of exactly 128 byte length into a File without performing any checks (such as length or null-termination).

Panics if slice is not 128 bytes.

Useful if you are handling the return of parse_file.

pub fn to_string(&self) -> CString

Convert the internal array to a null-terminated string representation with padding removed.

pub fn len(&self) -> usize

Get the length of File.

Note that this returns the length of the inner array which is always 128. To get the length of its string representation call file.to_string().len().

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl From<&File> for [u8; 128]

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