Struct ListSessionsRequest 

pub struct ListSessionsRequest {
    pub features: Option<Features>,
    pub dc: Option<String>,
    pub ns: Option<String>,
}

List Sessions

This endpoint returns the list of active sessions.

• Path: session/list
• Method: GET
• Response: Vec
• Reference: https://www.consul.io/api-docs/session#list-sessions

Fields

features: Option<Features>

dc: Option<String>

ns: Option<String>

Implementations

impl ListSessionsRequest

pub fn builder() -> ListSessionsRequestBuilder

Trait Implementations

impl Clone for ListSessionsRequest

fn clone(&self) -> ListSessionsRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListSessionsRequest

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

Formats the value using the given formatter.

impl Default for ListSessionsRequest

fn default() -> ListSessionsRequest

Returns the “default value” for a type.

impl Endpoint for ListSessionsRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = Vec<SessionEntry>

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 impl Client, ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,

impl FeaturedEndpoint for ListSessionsRequest

fn features(&self) -> Option<Features>

impl Serialize for ListSessionsRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.