Struct GetCategoryRequest

pub struct GetCategoryRequest {
    pub ids: Vec<Uuid>,
    pub scope: Option<CategoryTreeScope>,
}

Request to get a tree of categories.

Examples

There are a few different use cases.

get root categories.

GetCategoryRequest { ids: vec![], scope: None }

Additionally, you can do the same with scope: Some(CategoryTreeScope::Ancestors) but it is not considered the cannonical form.

get all categories

GetCategoryRequest { ids: vec![], scope: Some(CategoryTreeScope::Descendants) }

get exact categories

GetCategoryRequest { ids: vec![id1, id2, ...], scope: None }

get exact categories and their ancestors

GetCategoryRequest { ids: vec![id1, id2, ...], scope: Some(CategoryTreeScope::Ancestors) }

get exact categories and their decendants.

GetCategoryRequest { ids: vec![id1, id2, ...], scope: Some(CategoryTreeScope::Descendants) }

Fields

ids: Vec<Uuid>

The exact ids to be included in the response.

scope: Option<CategoryTreeScope>

Which direction to follow the tree.

Trait Implementations

impl Debug for GetCategoryRequest

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

Formats the value using the given formatter.

impl Default for GetCategoryRequest

fn default() -> GetCategoryRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetCategoryRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GetCategoryRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.