Struct File

pub struct File {
    pub date: Option<DateTime>,
    pub media_type: Option<String>,
    pub name: Option<String>,
    pub descs: BTreeMap<String, String>,
    pub size: Option<u64>,
    pub range: Option<Range>,
    pub hashes: Vec<Hash>,
}

Represents a file to be transferred.

Fields

date: Option<DateTime>

The date of last modification of this file.

media_type: Option<String>

The MIME type of this file.

name: Option<String>

The name of this file.

descs: BTreeMap<String, String>

The description of this file, possibly localised.

size: Option<u64>

The size of this file, in bytes.

range: Option<Range>

Used to request only a part of this file.

hashes: Vec<Hash>

A list of hashes matching this entire file.

Implementations

impl File

pub fn new() -> File

Creates a new file descriptor.

pub fn with_date(self, date: DateTime) -> File

Sets the date of last modification on this file.

pub fn with_date_str(self, date: &str) -> Result<File, Error>

Sets the date of last modification on this file from an ISO-8601 string.

pub fn with_media_type(self, media_type: String) -> File

Sets the MIME type of this file.

pub fn with_name(self, name: String) -> File

Sets the name of this file.

pub fn add_desc(self, lang: &str, desc: String) -> File

Sets a description for this file.

pub fn with_size(self, size: u64) -> File

Sets the file size of this file, in bytes.

pub fn with_range(self, range: Range) -> File

Request only a range of this file.

pub fn add_hash(self, hash: Hash) -> File

Add a hash on this file.

Trait Implementations

impl AsXml for File

type ItemIter<'xso_proc_as_xml_iter_lifetime> = FileAsXmlIterator<'xso_proc_as_xml_iter_lifetime>

The iterator type.

fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, Error>

Return an iterator which emits the contents of the struct or enum as serialisable Item items.

fn as_xml_dyn_iter<'x>( &'x self, ) -> Result<Box<dyn Iterator<Item = Result<Item<'x>, Error>> + 'x>, Error>

Return the same iterator as as_xml_iter, but boxed to erase the concrete iterator 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 Default for File

fn default() -> File

Returns the “default value” for a type.

impl From<&File> for Element

fn from(other: &File) -> Self

Converts to this type from the input type.

impl From<File> for Element

fn from(other: File) -> Self

Converts to this type from the input type.

impl FromXml for File

type Builder = FileFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ctx: &Context<'_>, ) -> Result<Self::Builder, FromEventsError>

Attempt to initiate the streamed construction of this struct from XML.

fn xml_name_matcher() -> XmlNameMatcher<'static>

Return a predicate which determines if Self may be parsed from a given XML element.

impl TryFrom<Element> for File

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(other: Element) -> Result<Self, FromElementError>

Performs the conversion.