Skip to main content

## GetItemsOptions

# Struct GetItemsOptions

Source

    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>,
    }

Expand description

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§

Source §

### impl Clone for GetItemsOptions

Source §

#### fn clone(&self) -> GetItemsOptions

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

### impl Debug for GetItemsOptions

Source §

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

Formats the value using the given formatter. Read more
Source §

### impl Default for GetItemsOptions

Source §

#### fn default() -> GetItemsOptions

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

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

Source §

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

Deserialize this value from the given Serde deserializer. Read more
Source §

### impl NamedType for GetItemsOptions

Source §

#### fn sid() -> SpectaID

Source §

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

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

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

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

### impl Serialize for GetItemsOptions

Source §

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

Serialize this value into the given Serde serializer. Read more
Source §

### impl Type for GetItemsOptions

Source §

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

Returns the definition of a type using the provided generics. Read more
Source §

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

### impl Flatten for GetItemsOptions

## Auto Trait Implementations§

§

### impl Freeze for GetItemsOptions

§

### impl RefUnwindSafe for GetItemsOptions

§

### impl Send for GetItemsOptions

§

### impl Sync for GetItemsOptions

§

### impl Unpin for GetItemsOptions

§

### impl UnsafeUnpin for GetItemsOptions

§

### impl UnwindSafe for GetItemsOptions

## 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> CloneToUninit for T
where T: Clone,

Source §

#### 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<'de, D, R> CommandArg<'de, R> for D
where D: Deserialize<'de>, R: Runtime,

§

#### fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>

Derives an instance of `Self` from the [`CommandItem`]. Read more
Source §

### impl<T> From<T> for T

Source §

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> FunctionArg for T
where T: Type,

§

#### fn to_datatype(type_map: &mut TypeCollection) -> Option<DataType>

Gets the type of an argument as a [`DataType`]. Read more
§

### 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
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.

§

### impl<T> IpcResponse for T
where T: Serialize,

§

#### fn body(self) -> Result<InvokeResponseBody, Error>

Resolve the IPC response body.
§

### impl<T> NoneValue for T
where T: Default,

§

#### type NoneType = T

§

#### fn null_value() -> T

The none-equivalent value.
§

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

§

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

#### 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> Same for T

Source §

#### type Output = T

Should always be `Self`
§

### impl<T> ScopeObject for T
where T: Send + Sync + Debug + DeserializeOwned + 'static,

§

#### type Error = Error

The error type.
§

#### fn deserialize<R>( _app: &AppHandle<R>, raw: Value, ) -> Result<T, <T as ScopeObject>::Error>
where R: Runtime,

Deserialize the raw scope value.
Source §

### impl<T> Serialize for T
where T: Serialize + ?Sized,

Source §

#### fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source §

#### fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source §

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

Source §

#### type Owned = T

The resulting type after obtaining ownership.
Source §

#### fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. 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.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

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

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

§

### impl<T> UserEvent for T
where T: Debug + Clone + Send + 'static,