Skip to main content

ShareLinkBundle

paperless_api::share_link_bundle

Struct ShareLinkBundle

pub struct ShareLinkBundle {
    pub id: ShareLinkBundleId,
    pub documents: Vec<DocumentId>,
    pub file_version: ShareLinkFileVersion,
    pub slug: String,
    pub created: DateTime<Utc>,
    pub built_at: DateTime<Utc>,
    pub expiration: DateTime<Utc>,
    pub size_bytes: u32,
    pub document_count: u32,
    pub status: ShareLinkBundleStatus,
}

Expand description

A share link bundle.

Fields§

§id: ShareLinkBundleId

Unique identifier of the share link bundle.

§documents: Vec<DocumentId>

The documents in the bundle.

§file_version: ShareLinkFileVersion

File version of the share link.

§slug: String

Slug of the bundle.

§created: DateTime<Utc>

When the bundle was created.

§built_at: DateTime<Utc>

When the bundle was built.

§expiration: DateTime<Utc>

When the bundle expires.

§size_bytes: u32

Size of the bundle in number of bytes.

§document_count: u32

Number of documents in the bundle.

§status: ShareLinkBundleStatus

The status of the bundle.

Implementations§

impl ShareLinkBundle

pub fn url(&self, client: &PaperlessClient) -> String

Returns the full URL of the share link.

Trait Implementations§

impl Clone for ShareLinkBundle

fn clone(&self) -> ShareLinkBundle

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl CreateDto for ShareLinkBundle

type Id = ShareLinkBundleId

The ID type for this item.

type BaseType = ShareLinkBundle

The base type for the DTO.

impl Debug for ShareLinkBundle

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ShareLinkBundle

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Item for ShareLinkBundle

type Id = ShareLinkBundleId

The ID type for this item.

fn id(&self) -> Self::Id

Returns the ID of this item.

fn endpoint() -> &'static str

Returns the API endpoint for this item.

impl Serialize for ShareLinkBundle

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl UpdateDto for ShareLinkBundle

type Id = ShareLinkBundleId

The ID type for this item.

type BaseType = ShareLinkBundle

The base type for the DTO.

Auto Trait Implementations§

impl Freeze for ShareLinkBundle

impl RefUnwindSafe for ShareLinkBundle

impl Send for ShareLinkBundle

impl Sync for ShareLinkBundle

impl Unpin for ShareLinkBundle

impl UnsafeUnpin for ShareLinkBundle

impl UnwindSafe for ShareLinkBundle

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more