Skip to main content

Aggregate

Struct Aggregate 

Source
pub struct Aggregate {
    pub id: NodeId,
    pub parent: NodeId,
    pub group_by: GroupBy,
    pub value: String,
    pub relationships: Vec<String>,
    pub count: u64,
    pub query: QueryParams,
}
Expand description

A group of neighbors collapsed into one summary. Descending it is a host decision, not an engine one — see DescendOutcome::Subsearch.

Deliberately carries no pre-rendered display string: value and count are data, and display() composes them so a host can phrase or localize it differently (via the label_text style rule) without parsing anything back out.

Fields§

§id: NodeId

Stable handle. The radial view renders these as __agg:<id>.

§parent: NodeId

The node this group hangs off. Derived on receipt and never trusted from the wire — whoever ran the query knows which node it asked about, so a derived value cannot be wrong and no provider can forget to set it. Same rule as NeighborResult::pending.

§group_by: GroupBy§value: String

The shared value along that dimension: “OF_TYPE”, “Sorcery”, “rare”.

§relationships: Vec<String>

Optional sub-data: distinct relationship types the members are reached through. Empty means UNSTATED, never “no relationships” — a node always reaches its neighbors through something, so an empty list can only mean the provider declined the extra aggregation. Advisory only: never branch on emptiness to conclude anything about the graph.

§count: u64§query: QueryParams

Opaque paging token that makes the group fetchable. Without it a host knows N things exist but cannot reach them, and cannot reconstruct the cursor because its encoding is provider-defined.

Implementations§

Source§

impl Aggregate

Source

pub fn display(&self) -> String

Default display text, e.g. “32 Sorcery”. Composed rather than transmitted so presentation stays overridable in the styling layer.

Trait Implementations§

Source§

impl Clone for Aggregate

Source§

fn clone(&self) -> Aggregate

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 Aggregate

Source§

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

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

impl<'de> Deserialize<'de> for Aggregate

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

Source§

fn eq(&self, other: &Aggregate) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Aggregate

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 StructuralPartialEq for Aggregate

Auto Trait Implementations§

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

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

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.