Crate chris

Source
Expand description

Client library for ChRIS built on reqwest.

Re-exports§

pub use reqwest;

Modules§

errors
Errors for this crate. About anyhow: see https://github.com/TrueLayer/reqwest-middleware/issues/119
search
Everything having to do with pagination of collection and search APIs from CUBE.
types

Structs§

Account
CUBE username and password struct. Account is a builder for [ChrisClient].
AnonChrisClient
Anonymous ChRIS client.
BasicFileResponse
The common data from any response object, and what comes back from the filebrowser API.
ComputeResourceResponse
FeedFileResponse
A file created by a plugin instance.
FeedResponse
FileBrowser
A client for the ChRIS filebrowser API.
FileBrowserEntry
A filebrowser API response, which contains a listing for a ChRIS file path.
FileUploadResponse
A file uploaded to userfiles.
LazyLinkedModel
You can think of LazyLinkedModel as a lazy LinkedModel: it has methods for changing this resource, and can be transformed into a LinkedModel by calling LazyLinkedModel::get.
LinkedModel
A client to the subset of the CUBE API linked to by this object’s generic type. In less fancy speak, LinkedModel is a thing which can get, create, modify, or delete other things or even itself.
NoteResponse
PipelineResponse
PluginInstanceParameterResponse
PluginInstanceResponse
PluginInstanceReturnStatus
PluginInstanceSummary
See https://github.com/FNNDSC/ChRIS_ultron_backEnd/blob/01b2928f65738d4266d210d80dc02eba3e530b20/chris_backend/plugininstances/services/manager.py#L862-L885
PluginParameter
PluginResponse
RoAccess
Read-only access
RwAccess
Read-write access
SummaryCompute
SummaryStatus
WorkflowResponse

Enums§

EitherClient
Either an anonymous client or a logged in user. A shoddy workaround for combining how enums work and how [AccessRw] and [AccessRo] could be represented using an enum.

Traits§

Access
An indicator for what mode API items can be accessed.
BaseChrisClient
APIs you can interact with without having to log in.
Downloadable
A CUBE resource which has file_resource, fname, and fsize.

Type Aliases§

BasicFile
A basic downloadable CUBE file.
ChrisClient
ChRIS user client with read-write API access.
Feed
ChRIS feed.
FeedRo
A feed which you can read but not edit.
FeedRw
A feed which you can edit.
LazyFeed
A lazy feed object.
LazyFeedRw
A lazy feed object you can edit.
LazyNote
Similar to Note but without content.
Note
ChRIS feed note.
Pipeline
A ChRIS pipeline.
PipelineRo
A ChRIS pipeline, publicly-accessed.
PipelineRw
A ChRIS pipeline you can run.
Plugin
A ChRIS plugin.
PluginInstance
PluginInstanceParameter
PluginInstanceRo
PluginInstanceRw
PluginRo
A publicly accessed plugin. You cannot create plugin instances of a PluginRo.
PluginRw
A ChRIS plugin. Call PluginRw::create_instance to “run” this plugin.
RoClient
A client which accesses read-only APIs only. It may use authorization, in which case it is able to read private collections.
Workflow