Struct UploadSpec 

pub struct UploadSpec {
    pub filename: String,
    pub source: UploadSource,
}

Specification for one file upload.

Fields

filename: String

Filename to expose in Figshare.

source: UploadSource

Upload source.

Implementations

impl UploadSpec

pub fn from_path(path: impl Into<PathBuf>) -> Result<Self>

Builds an upload spec from a local path.

Errors

Returns an error if the path does not contain a final filename segment.

pub fn from_reader( filename: impl Into<String>, reader: impl Read + Send + 'static, content_length: u64, ) -> Self

Builds an upload spec from a reader and explicit metadata.

Trait Implementations

impl Debug for UploadSpec

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

Formats the value using the given formatter.

impl UploadSpecLike for UploadSpec

fn filename(&self) -> &str

Returns the remote filename that the upload will expose.

fn source_kind(&self) -> UploadSourceKind

Returns the kind of source backing this upload.

fn content_length(&self) -> Option<u64>

Returns the exact content length when it is already known cheaply.

fn content_type(&self) -> Option<&str>

Returns the HTTP content type when the upload tracks one.