pub struct ListSessionsParams {
pub channel: Uri,
pub limit: Option<i64>,
pub cursor: Option<String>,
}Expand description
Returns a list of session summaries. Used to populate session lists and sidebars.
The session list is not part of the state tree because it can be arbitrarily
large. Clients fetch it imperatively and maintain a local cache updated by
root/sessionAdded and root/sessionRemoved notifications.
A large catalogue can be fetched incrementally via the {@link PaginatedParams}
limit/cursor inputs (see that type for the full pagination contract). The
server SHOULD return most-recently-modified entries first, so the first page
is the immediately useful one. The root/session* notifications keep an
already-fetched page live; pagination governs only the initial and backfill
fetches.
Fields§
§channel: UriChannel URI this command targets.
limit: Option<i64>Maximum number of entries to return in this page. The server SHOULD respect this bound but MAY return fewer entries and MAY impose its own upper cap. Omit to let the server choose the page size.
cursor: Option<String>Opaque pagination cursor from a previous {@link PaginatedResult.nextCursor}.
Omit to fetch the first page. Cursors are server-defined and MUST be treated
as opaque — do not parse, modify, or persist them across connections. An
unrecognised cursor SHOULD be rejected with an InvalidParams error.
Trait Implementations§
Source§impl Clone for ListSessionsParams
impl Clone for ListSessionsParams
Source§fn clone(&self) -> ListSessionsParams
fn clone(&self) -> ListSessionsParams
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ListSessionsParams
impl Debug for ListSessionsParams
Source§impl<'de> Deserialize<'de> for ListSessionsParams
impl<'de> Deserialize<'de> for ListSessionsParams
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for ListSessionsParams
impl PartialEq for ListSessionsParams
Source§fn eq(&self, other: &ListSessionsParams) -> bool
fn eq(&self, other: &ListSessionsParams) -> bool
self and other values to be equal, and is used by ==.