Struct GetItemsOptions 

pub struct GetItemsOptions {
    pub start_index: Option<usize>,
    pub limit: Option<usize>,
    pub sort_by: Option<String>,
    pub sort_order: Option<String>,
    pub include_item_types: Option<Vec<String>>,
    pub recursive: Option<bool>,
    pub fields: Option<Vec<String>>,
    pub genres: Option<Vec<String>>,
    pub favorites_only: Option<bool>,
    pub parent_kind: Option<MediaKind>,
}

Options for querying items

Fields

start_index: Option<usize>

limit: Option<usize>

sort_by: Option<String>

sort_order: Option<String>

include_item_types: Option<Vec<String>>

recursive: Option<bool>

fields: Option<Vec<String>>

genres: Option<Vec<String>>

favorites_only: Option<bool>

Restrict the listing to favourited items. Backs the per-library favourites toggle; composes with every other filter here.

TRACES: UR-067 | DR-116 | UT-104

parent_kind: Option<MediaKind>

What the container being listed is, so the repository can pick the order its children belong in when the caller names none. The frontend sends the neutral kind it already holds; what that kind implies about ordering is decided here, the same division as SearchScope.

TRACES: UR-007 | DR-257

Trait Implementations

impl Clone for GetItemsOptions

fn clone(&self) -> GetItemsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetItemsOptions

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

Formats the value using the given formatter.

impl Default for GetItemsOptions

fn default() -> GetItemsOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetItemsOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for GetItemsOptions

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to [Type::inline] but returns a [NamedDataType] instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a [NamedDataType] instead.

impl Serialize for GetItemsOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for GetItemsOptions

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for GetItemsOptions