Skip to main content

DocumentQueryBuilder

paperless_api::document_query

Struct DocumentQueryBuilder 

Source 
pub struct DocumentQueryBuilder { /* private fields */ }
Expand description

Builder for constructing document queries.

Implementations§

Source§

impl DocumentQueryBuilder

Source

pub fn archive_serial_number( self, archive_serial_number: ArchiveSerialNumber, ) -> Self

Filters documents which have the given archive serial number.

Source

pub fn correspondent_id_in( self, correspondent_id_in: Vec<CorrespondentId>, ) -> Self

Filters documents which have any of the given correspondents.

Source

pub fn correspondent_name_icontains( self, correspondent_name_icontains: String, ) -> Self

Filters documents which have a correspondent name containing the given string.

Source

pub fn content_icontains(self, content_icontains: String) -> Self

Filters documents which have content containing the given string.

Source

pub fn tags_id_in(self, tags_id_in: Vec<TagId>) -> Self

Filters documents which have any of the given tags.

Source

pub fn full_content(self, full_content: bool) -> Self

Returns documents with full content (truncated by default to save bandwidth).

Source

pub fn full_permissions(self, full_permissions: bool) -> Self

Returns documents with full permissions data.

Source

pub fn build(self) -> DocumentQuery

Builds the query.

Trait Implementations§

Source§

impl Default for DocumentQueryBuilder

Source§

fn default() -> DocumentQueryBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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