Struct ArticleFile 

pub struct ArticleFile {

    pub id: FileId,
    pub name: String,
    pub size: u64,
    pub is_link_only: Option<bool>,
    pub download_url: Option<Url>,
    pub status: Option<FileStatus>,
    pub viewer_type: Option<String>,
    pub preview_state: Option<String>,
    pub upload_url: Option<Url>,
    pub upload_token: Option<String>,
    pub supplied_md5: Option<String>,
    pub computed_md5: Option<String>,
    pub extra: BTreeMap<String, Value>,
}

Public/private file representation attached to an article.

Fields

id: FileId

File identifier.

name: String

File name.

size: u64

File size in bytes.

is_link_only: Option<bool>

Whether the file is only linked and not stored on Figshare.

download_url: Option<Url>

Public or private file download URL, when present.

status: Option<FileStatus>

Private file status, when present.

viewer_type: Option<String>

Viewer type hint, when present.

preview_state: Option<String>

Preview state hint, when present.

upload_url: Option<Url>

Upload session URL, when present.

upload_token: Option<String>

Upload token, when present.

supplied_md5: Option<String>

Client-provided MD5 used when initiating the upload, when present.

computed_md5: Option<String>

Server-computed MD5, when present.

extra: BTreeMap<String, Value>

Additional untyped fields preserved for forward compatibility.

Implementations

impl ArticleFile

pub fn upload_session_url(&self) -> Option<&Url>

Returns the upload session URL, when the file is hosted on Figshare.

Trait Implementations

impl Clone for ArticleFile

fn clone(&self) -> ArticleFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArticleFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArticleFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ArticleFile

fn eq(&self, other: &ArticleFile) -> 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 RepositoryFile for ArticleFile

type Id = FileId

Service-specific file identifier type.

fn file_id(&self) -> Option<Self::Id>

Returns the file identifier when the service exposes one.

fn file_name(&self) -> &str

Returns the remote filename or key.

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

Returns the file size in bytes when known.

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

Returns a checksum string when the service reports one.

fn download_url(&self) -> Option<&Url>

Returns the best direct download URL when one is already present on the payload.

impl Serialize for ArticleFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ArticleFile