Struct ListUsersOnPaperDocArgs

#[non_exhaustive]
pub struct ListUsersOnPaperDocArgs {
    pub doc_id: PaperDocId,
    pub limit: i32,
    pub filter_by: UserOnPaperDocFilter,
}

Available on crate features async_routes and dbx_paper only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

doc_id: PaperDocId

The Paper doc ID.

limit: i32

Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

filter_by: UserOnPaperDocFilter

Specify this attribute if you want to obtain users that have already accessed the Paper doc.

Implementations

impl ListUsersOnPaperDocArgs

pub fn new(doc_id: PaperDocId) -> Self

pub fn with_limit(self, value: i32) -> Self

pub fn with_filter_by(self, value: UserOnPaperDocFilter) -> Self

Trait Implementations

impl Clone for ListUsersOnPaperDocArgs

fn clone(&self) -> ListUsersOnPaperDocArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListUsersOnPaperDocArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ListUsersOnPaperDocArgs

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

Deserialize this value from the given Serde deserializer.

impl From<ListUsersOnPaperDocArgs> for RefPaperDoc

fn from(subtype: ListUsersOnPaperDocArgs) -> Self

Converts to this type from the input type.

impl PartialEq for ListUsersOnPaperDocArgs

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

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

Serialize this value into the given Serde serializer.

impl Eq for ListUsersOnPaperDocArgs

impl StructuralPartialEq for ListUsersOnPaperDocArgs