Skip to main content

SearchHit

Struct SearchHit 

Source
pub struct SearchHit {
Show 16 fields pub obj_tp: char, pub obj_id: Box<str>, pub part_id: Option<Box<str>>, pub part_kind: Option<Box<str>>, pub parent_part: Option<Box<str>>, pub anchor_id: Option<Box<str>>, pub app_id: Option<Box<str>>, pub nav_param: Option<Box<str>>, pub content_type: Option<Box<str>>, pub title: Option<Box<str>>, pub snippet: Option<Box<str>>, pub snippet_matches: Option<Box<[SearchMatch]>>, pub tags: Option<Box<[Box<str>]>>, pub owner_tag: Option<Box<str>>, pub updated_at: Timestamp, pub score: f64,
}
Expand description

One result row on the wire.

Absent fields are omitted rather than sent as null: the frontend types these as optional (T.optional in libs/types/src/types.ts), which in @symbion/runtype means “may be missing”, not “may be null”. A hit is mostly-empty for whole-object rows, so this also keeps the payload small.

Fields§

§obj_tp: char

'F' file, 'D' deep document part, 'A' action, 'P' profile.

§obj_id: Box<str>§part_id: Option<Box<str>>

Deep-link key — for notillo, the page id.

§part_kind: Option<Box<str>>§parent_part: Option<Box<str>>§anchor_id: Option<Box<str>>

Finest-grained anchor inside the part — for notillo, the block id.

§app_id: Option<Box<str>>

App id parsed out of cloudillo/<appId>, for building a cl: ref.

§nav_param: Option<Box<str>>

Deep-link query param name from the format manifest, e.g. "nav".

§content_type: Option<Box<str>>§title: Option<Box<str>>§snippet: Option<Box<str>>

Server-built excerpt as plain text; snippetMatches carries the highlight out of band. Contains no markup and must not be fed to an HTML sink.

Absent for every hit when the tenant has search.store_text off: that mode keeps no plain-text copy to cut an excerpt out of. A result list must fall back to title + tags rather than assume a snippet is there.

§snippet_matches: Option<Box<[SearchMatch]>>

Ranges within snippet to emphasise. UTF-16 code-unit offsets, so a client can slice snippet directly; ascending and non-overlapping.

§tags: Option<Box<[Box<str>]>>§owner_tag: Option<Box<str>>§updated_at: Timestamp§score: f64

Sign-flipped bm25(): higher is more relevant.

Trait Implementations§

Source§

impl Debug for SearchHit

Source§

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

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

impl Serialize for SearchHit

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

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more