Struct FigshareClient 

pub struct FigshareClient { /* private fields */ }

Typed async client for the core Figshare REST API.

Implementations

impl FigshareClient

pub fn builder(auth: Auth) -> FigshareClientBuilder

Starts building a new client from authentication settings.

pub fn new(auth: Auth) -> Result<Self, FigshareError>

Builds a client with default endpoint and polling options.

Errors

Returns an error if the underlying HTTP client cannot be initialized.

pub fn with_token(token: impl Into<String>) -> Result<Self, FigshareError>

Builds a client directly from a raw API token.

Errors

Returns an error if the underlying HTTP client cannot be initialized.

pub fn anonymous() -> Result<Self, FigshareError>

Builds an anonymous client for public API calls.

Errors

Returns an error if the underlying HTTP client cannot be initialized.

pub fn from_env() -> Result<Self, FigshareError>

Builds a client from Auth::TOKEN_ENV_VAR.

Errors

Returns an error if the environment variable is missing or invalid, or if the underlying HTTP client cannot be initialized.

pub fn endpoint(&self) -> &Endpoint

Returns the configured API endpoint.

pub fn poll_options(&self) -> &PollOptions

Returns the configured polling behavior.

pub fn request_timeout(&self) -> Option<Duration>

Returns the configured overall HTTP request timeout.

pub fn connect_timeout(&self) -> Option<Duration>

Returns the configured TCP connect timeout.

pub async fn list_licenses(&self) -> Result<Vec<ArticleLicense>, FigshareError>

Lists public licenses.

Errors

Returns an error if the request fails or Figshare returns a non-success response.

pub async fn list_categories( &self, ) -> Result<Vec<ArticleCategory>, FigshareError>

Lists public categories.

Errors

Returns an error if the request fails or Figshare returns a non-success response.

pub async fn list_account_categories( &self, ) -> Result<Vec<ArticleCategory>, FigshareError>

Lists categories available to the authenticated account.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn list_public_articles( &self, query: &ArticleQuery, ) -> Result<Vec<Article>, FigshareError>

Lists public articles.

Errors

Returns an error if the request fails or Figshare returns a non-success response.

pub async fn list_public_article_versions( &self, id: ArticleId, ) -> Result<Vec<ArticleVersion>, FigshareError>

Lists public versions for one article.

Errors

Returns an error if the request fails or Figshare returns a non-success response.

pub async fn get_public_article_version( &self, id: ArticleId, version: u64, ) -> Result<Article, FigshareError>

Reads one specific public article version.

Errors

Returns an error if the request fails or Figshare returns a non-success response.

pub async fn list_own_articles( &self, query: &ArticleQuery, ) -> Result<Vec<Article>, FigshareError>

Lists the authenticated account’s own articles.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn search_own_articles( &self, query: &ArticleQuery, ) -> Result<Vec<Article>, FigshareError>

Searches the authenticated account’s own articles.

Errors

Returns an error if authentication is missing, if the query is invalid, if the request fails, or if Figshare returns a non-success response.

pub async fn get_own_article( &self, id: ArticleId, ) -> Result<Article, FigshareError>

Reads one private article owned by the authenticated account.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn delete_article(&self, id: ArticleId) -> Result<(), FigshareError>

Deletes a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn reserve_doi(&self, id: ArticleId) -> Result<Doi, FigshareError>

Reserves a DOI for a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn list_files( &self, id: ArticleId, ) -> Result<Vec<ArticleFile>, FigshareError>

Lists files attached to a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn list_public_article_version_files( &self, article_id: ArticleId, version: u64, ) -> Result<Vec<ArticleFile>, FigshareError>

Lists files attached to one public article version.

Errors

Returns an error if the request fails or if Figshare returns a non-success response.

pub async fn get_file( &self, article_id: ArticleId, file_id: FileId, ) -> Result<ArticleFile, FigshareError>

Reads one file attached to a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn delete_file( &self, article_id: ArticleId, file_id: FileId, ) -> Result<(), FigshareError>

Deletes a file from a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn initiate_file_upload( &self, article_id: ArticleId, name: &str, size: u64, md5: &str, ) -> Result<ArticleFile, FigshareError>

Initiates a hosted file upload for a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn initiate_link_file( &self, article_id: ArticleId, link: &str, ) -> Result<ArticleFile, FigshareError>

Initiates a link-only file attachment for a private article.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn get_upload_session( &self, upload_url: &Url, ) -> Result<UploadSession, FigshareError>

Reads one upload session from the upload service.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn upload_part( &self, upload_url: &Url, part_no: u64, bytes: Vec<u8>, ) -> Result<(), FigshareError>

Uploads one part to the upload service.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn reset_upload_part( &self, upload_url: &Url, part_no: u64, ) -> Result<(), FigshareError>

Resets one uploaded part.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn complete_file_upload( &self, article_id: ArticleId, file_id: FileId, ) -> Result<(), FigshareError>

Marks an uploaded file as complete.

Errors

Returns an error if authentication is missing, if the request fails, or if Figshare returns a non-success response.

pub async fn upload_path( &self, article_id: ArticleId, path: &Path, ) -> Result<ArticleFile, FigshareError>

Uploads a local file path to a private article.

Errors

Returns an error if authentication is missing, if the local file cannot be read, if the request fails, or if Figshare returns a non-success response.

pub async fn upload_reader<R>( &self, article_id: ArticleId, filename: &str, reader: R, content_length: u64, ) -> Result<ArticleFile, FigshareError>

where R: Read + Send + 'static,

Uploads data from a blocking reader by staging it to a temporary file and performing a standard Figshare hosted upload.

Errors

Returns an error if authentication is missing, if staging the reader fails, if the request fails, or if Figshare returns a non-success response.

impl FigshareClient

pub async fn open_public_article_file_by_name( &self, article_id: ArticleId, name: &str, latest: bool, ) -> Result<DownloadStream, FigshareError>

Opens a file from a public article by exact file name.

When latest is true, the latest public article version is resolved before selecting the file.

Errors

Returns an error if the article or file cannot be resolved, if the request fails, or if Figshare returns a non-success response.

pub async fn open_article_file_by_doi( &self, doi: &Doi, name: &str, latest: bool, ) -> Result<DownloadStream, FigshareError>

Opens a file from a public article selected by DOI.

When latest is true, the latest public article version is resolved before selecting the file.

Errors

Returns an error if the article or file cannot be resolved, if the request fails, or if Figshare returns a non-success response.

pub async fn open_own_article_file_by_name( &self, article_id: ArticleId, name: &str, ) -> Result<DownloadStream, FigshareError>

Opens a file from one of the authenticated account’s own articles by exact file name.

Errors

Returns an error if authentication is missing, if the article or file cannot be resolved, if the request fails, or if Figshare returns a non-success response.

pub async fn download_public_article_file_by_name_to_path( &self, article_id: ArticleId, name: &str, latest: bool, path: &Path, ) -> Result<ResolvedDownload, FigshareError>

Downloads a file from a public article by exact file name.

Errors

Returns an error if the article or file cannot be resolved, if the request fails, or if writing the destination path fails.

pub async fn download_article_file_by_doi_to_path( &self, doi: &Doi, name: &str, latest: bool, path: &Path, ) -> Result<ResolvedDownload, FigshareError>

Downloads a file from a public article resolved by DOI.

Errors

Returns an error if the article or file cannot be resolved, if the request fails, or if writing the destination path fails.

pub async fn download_own_article_file_by_name_to_path( &self, article_id: ArticleId, name: &str, path: &Path, ) -> Result<ResolvedDownload, FigshareError>

Downloads a file from one of the authenticated account’s own articles by exact file name.

Errors

Returns an error if authentication is missing, if the article or file cannot be resolved, if the request fails, or if writing the destination path fails.

Trait Implementations

impl ClientContext for FigshareClient

type Endpoint = Endpoint

Service-specific endpoint configuration type.

type PollOptions = PollOptions

Service-specific polling configuration type.

type Error = FigshareError

Service-specific error type.

fn endpoint(&self) -> &Self::Endpoint

Returns the configured endpoint roots.

fn poll_options(&self) -> &Self::PollOptions

Returns the configured polling behavior.

fn request_timeout(&self) -> Option<Duration>

Returns the overall request timeout, when configured.

fn connect_timeout(&self) -> Option<Duration>

Returns the TCP connect timeout, when configured.

impl Clone for FigshareClient

fn clone(&self) -> FigshareClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CreatePublication for FigshareClient

type CreateTarget = NoCreateTarget

Caller-supplied creation target type.

type Metadata = ArticleMetadata

Service-specific metadata type.

type Upload = UploadSpec

Service-specific upload specification type.

type Output = PublishedArticle

Service-specific workflow result type.

async fn create_publication( &self, request: CreatePublicationRequest<Self::CreateTarget, Self::Metadata, Self::Upload>, ) -> Result<Self::Output, Self::Error>

Runs the service’s “create a new published resource” workflow.

impl Debug for FigshareClient

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

Formats the value using the given formatter.

impl DownloadNamedPublicFile for FigshareClient

type ResourceId = ArticleId

Service-specific resource identifier type.

type Download = ResolvedDownload

Service-specific download result metadata.

async fn download_named_public_file_to_path( &self, id: &Self::ResourceId, name: &str, path: &Path, ) -> Result<Self::Download, Self::Error>

Downloads one named file from a public resource.

impl DraftWorkflow for FigshareClient

type Draft = Article

Service-specific mutable draft type.

type Metadata = ArticleMetadata

Service-specific metadata type.

type Upload = UploadSpec

Service-specific upload specification type.

type FilePolicy = FileReplacePolicy

Service-specific draft file policy.

type UploadResult = ArticleFile

Service-specific upload result type.

type Published = Article

Result returned by the publish step.

async fn create_draft( &self, metadata: &Self::Metadata, ) -> Result<Self::Draft, Self::Error>

Creates a new mutable draft-like resource with the supplied metadata.

async fn update_draft_metadata( &self, draft_id: &<Self::Draft as DraftResource>::Id, metadata: &Self::Metadata, ) -> Result<Self::Draft, Self::Error>

Replaces or merges the draft metadata.

async fn reconcile_draft_files( &self, draft: &Self::Draft, policy: Self::FilePolicy, uploads: Vec<Self::Upload>, ) -> Result<Vec<Self::UploadResult>, Self::Error>

Reconciles the draft file set under the requested policy.

async fn publish_draft( &self, draft_id: &<Self::Draft as DraftResource>::Id, ) -> Result<Self::Published, Self::Error>

Publishes the draft-like resource.

impl ListResourceFiles for FigshareClient

type ResourceId = ArticleId

Service-specific resource identifier type.

type File = ArticleFile

Service-specific file entry type.

async fn list_resource_files( &self, id: &Self::ResourceId, ) -> Result<Vec<Self::File>, Self::Error>

Returns the complete visible file list for the resource.

impl LookupByDoi for FigshareClient

type Doi = Doi

Service-specific DOI type.

type Resource = Article

Returned public resource payload.

async fn get_public_resource_by_doi( &self, doi: &Self::Doi, ) -> Result<Self::Resource, Self::Error>

Fetches one public resource by DOI.

impl MaybeAuthenticatedClient for FigshareClient

fn has_auth(&self) -> bool

Returns whether the client currently has credentials available for authenticated calls.

impl ReadPublicResource for FigshareClient

type ResourceId = ArticleId

Service-specific resource identifier type.

type Resource = Article

Returned public resource payload.

async fn get_public_resource( &self, id: &Self::ResourceId, ) -> Result<Self::Resource, Self::Error>

Fetches one public resource.

impl ResolveLatestPublicResource for FigshareClient

type ResourceId = ArticleId

Service-specific resource identifier type.

type Resource = Article

Returned public resource payload.

async fn resolve_latest_public_resource( &self, id: &Self::ResourceId, ) -> Result<Self::Resource, Self::Error>

Resolves the latest public version in the resource family.

impl ResolveLatestPublicResourceByDoi for FigshareClient

type Doi = Doi

Service-specific DOI type.

type Resource = Article

Returned public resource payload.

async fn resolve_latest_public_resource_by_doi( &self, doi: &Self::Doi, ) -> Result<Self::Resource, Self::Error>

Resolves the latest public version in the DOI-backed resource family.

impl SearchPublicResources for FigshareClient

type Query = ArticleQuery

Service-specific query type.

type SearchResults = Vec<Article>

Service-specific search result shape.

async fn search_public_resources( &self, query: &Self::Query, ) -> Result<Self::SearchResults, Self::Error>

Executes a public search request.

impl UpdatePublication for FigshareClient

type ResourceId = ArticleId

Service-specific resource identifier type.

type Metadata = ArticleMetadata

Service-specific metadata type.

type FilePolicy = FileReplacePolicy

Service-specific upload-policy type.

type Upload = UploadSpec

Service-specific upload specification type.

type Output = PublishedArticle

Service-specific workflow result type.

async fn update_publication( &self, request: UpdatePublicationRequest<Self::ResourceId, Self::Metadata, Self::FilePolicy, Self::Upload>, ) -> Result<Self::Output, Self::Error>

Runs the service’s “update or upsert an existing resource” workflow.