Skip to main content

ChannelSearchService

nominal_api::endpoints::scout::channel::api

Trait ChannelSearchService 

Source 
pub trait ChannelSearchService {
    // Required methods
    fn get_locator_delimiters(
        &self,
        auth_: BearerToken,
        request: GetLocatorDelimitersRequest,
    ) -> Result<GetLocatorDelimitersResponse, Error>;
    fn list_channel_children(
        &self,
        auth_: BearerToken,
        request: ListChannelChildrenRequest,
    ) -> Result<ListChannelChildrenResponse, Error>;
    fn search_channels(
        &self,
        auth_: BearerToken,
        request: SearchChannelsRequest,
    ) -> Result<SearchChannelsResponse, Error>;
}
Expand description

Channel search over a DataFrame, which can expand to multiple locators.

Required Methods§

Source

fn get_locator_delimiters( &self, auth_: BearerToken, request: GetLocatorDelimitersRequest, ) -> Result<GetLocatorDelimitersResponse, Error>

Returns the expanded locator topology for a frame plus per-locator delimiter info.

Source

fn list_channel_children( &self, auth_: BearerToken, request: ListChannelChildrenRequest, ) -> Result<ListChannelChildrenResponse, Error>

Lazy one-level hierarchical expansion under parent. Returns a mix of leaf channels and prefix nodes, each labelled with the set of locators where they exist.

Source

fn search_channels( &self, auth_: BearerToken, request: SearchChannelsRequest, ) -> Result<SearchChannelsResponse, Error>

Flat text search across the frame. Returns matching channels, each labelled with the set of locators in which they exist.

Implementors§