Enum iroh_bytes::store::flat::FileName

pub enum FileName {
    PartialData(Hash, [u8; 16]),
    Data(Hash),
    PartialOutboard(Hash, [u8; 16]),
    Outboard(Hash),
    TempPaths(Hash, [u8; 16]),
    Paths(Hash),
    Meta(Vec<u8>),
}

A file name that indicates the purpose of the file.

Variants

PartialData(Hash, [u8; 16])

Incomplete data for the hash, with an unique id

Data(Hash)

File is storing data for the hash

PartialOutboard(Hash, [u8; 16])

File is storing a partial outboard

Outboard(Hash)

File is storing an outboard

We can have multiple files with the same outboard, in case the outboard does not contain hashes. But we don’t store those outboards.

TempPaths(Hash, [u8; 16])

Temporary paths file

Paths(Hash)

External paths for the hash

Meta(Vec<u8>)

File is going to be used to store metadata

Implementations

impl FileName

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, &'static str>

Get the file purpose from a path, handling weird cases

impl FileName

pub fn temporary(&self) -> bool

true if the purpose is for a temporary file

Trait Implementations

impl Clone for FileName

fn clone(&self) -> FileName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileName

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

Formats the value using the given formatter.

impl Display for FileName

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

Formats the value using the given formatter.

impl FromStr for FileName

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for FileName

fn eq(&self, other: &FileName) -> bool

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

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

impl StructuralEq for FileName

impl StructuralPartialEq for FileName