Struct LibrarySettings 

pub struct LibrarySettings {
    pub excluded_item_ids: Vec<String>,
}

Library browsing preferences.

Currently a single list: the folders (or whole libraries) the user has asked to keep out of browsing. It is a list of ids, never names — names are unstable, locale-dependent and non-unique, and the hardcoded name filter this setting replaced broke on exactly that. What the ids then hide is decided in repository::exclusions; this struct is only how the choice is carried and persisted.

The default is an empty list: nobody inherits another user’s folder layout.

TRACES: UR-076 | DR-209

Fields

excluded_item_ids: Vec<String>

Stable item ids of the folders/libraries hidden from browsing.

#[serde(default)] so settings JSON persisted before this field existed loads as the previous behaviour (nothing hidden).

Implementations

impl LibrarySettings

pub fn sanitised(self) -> Self

Drop blanks and duplicates from the id list.

Applied on the way in from IPC and on the way out of the database, so a hand-edited or half-written value cannot make the list grow without bound or carry an empty id (which would match nothing but still be shown as a selection in the picker).

TRACES: UR-076 | DR-209

Trait Implementations

impl Clone for LibrarySettings

fn clone(&self) -> LibrarySettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LibrarySettings

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

Formats the value using the given formatter.

impl Default for LibrarySettings

fn default() -> LibrarySettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LibrarySettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for LibrarySettings

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 PartialEq for LibrarySettings

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

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 LibrarySettings

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 Eq for LibrarySettings

impl Flatten for LibrarySettings

impl StructuralPartialEq for LibrarySettings