Enum Request

pub enum Request {
    Ping(RequestPing),
    Handshake(RequestHandshake),
    Phrases(RequestPhrases),
    Inspect(RequestInspect),
}

The toplevel request of the JSON specification.

This comes in three variants:

• Request::Ping to establish if a server is online.
• Request::Handshake to retrieve server metadata, such as supported versions, reasoner used, etc.
• Request::Phrases to send eFLINT phrases to the server and do reasoning.

Variants

Ping(RequestPing)

The Ping-request can be used to establish if a server is online and reachable.

Handshake(RequestHandshake)

The Handshake-request can be used to retrieve server metadata, such as supported versions, reasoner used, etc.

Phrases(RequestPhrases)

The Phrases-request can be used to do reasoning on the server by sending phrases.

Inspect(RequestInspect)

The Inspect-request can be used to query the server’s state.

Implementations

impl Request

pub fn is_ping(&self) -> bool

Checks if this request is a Request::Ping.

Returns

True if it is, or false if not.

pub fn ping(&self) -> &RequestPing

Returns this Request as if it’s a Request::Ping.

Returns

A reference to the internal RequestPing object.

Panics

This function may panic if this Request is not a Request::Ping.

pub fn ping_mut(&mut self) -> &mut RequestPing

Returns this Request as if it’s a Request::Ping.

Returns

A mutable reference to the internal RequestPing object.

Panics

This function may panic if this Request is not a Request::Ping.

pub fn into_ping(self) -> RequestPing

Returns this Request as if it’s a Request::Ping.

Returns

The internal RequestPing object.

Panics

This function may panic if this Request is not a Request::Ping.

pub fn is_handshake(&self) -> bool

Checks if this request is a Request::Handshake.

Returns

True if it is, or false if not.

pub fn handshake(&self) -> &RequestHandshake

Returns this Request as if it’s a Request::Handshake.

Returns

A reference to the internal RequestHandshake object.

Panics

This function may panic if this Request is not a Request::Handshake.

pub fn handshake_mut(&mut self) -> &mut RequestHandshake

Returns this Request as if it’s a Request::Handshake.

Returns

A mutable reference to the internal RequestHandshake object.

Panics

This function may panic if this Request is not a Request::Handshake.

pub fn into_handshake(self) -> RequestHandshake

Returns this Request as if it’s a Request::Handshake.

Returns

The internal RequestHandshake object.

Panics

This function may panic if this Request is not a Request::Handshake.

pub fn is_phrases(&self) -> bool

Checks if this request is a Request::Phrases.

Returns

True if it is, or false if not.

pub fn phrases(&self) -> &RequestPhrases

Returns this Request as if it’s a Request::Phrases.

Returns

A reference to the internal RequestPhrases object.

Panics

This function may panic if this Request is not a Request::Phrases.

pub fn phrases_mut(&mut self) -> &mut RequestPhrases

Returns this Request as if it’s a Request::Phrases.

Returns

A mutable reference to the internal RequestPhrases object.

Panics

This function may panic if this Request is not a Request::Phrases.

pub fn into_phrases(self) -> RequestPhrases

Returns this Request as if it’s a Request::Phrases.

Returns

The internal RequestPhrases object.

Panics

This function may panic if this Request is not a Request::Phrases.

pub fn is_inspect(&self) -> bool

Checks if this request is a Request::Inspect.

Returns

True if it is, or false if not.

pub fn inspect(&self) -> &RequestInspect

Returns this Request as if it’s a Request::Inspect.

Returns

A reference to the internal RequestInspect object.

Panics

This function may panic if this Request is not a Request::Inspect.

pub fn inspect_mut(&mut self) -> &mut RequestInspect

Returns this Request as if it’s a Request::Inspect.

Returns

A mutable reference to the internal RequestInspect object.

Panics

This function may panic if this Request is not a Request::Inspect.

pub fn into_inspect(self) -> RequestInspect

Returns this Request as if it’s a Request::Inspect.

Returns

The internal RequestInspect object.

Panics

This function may panic if this Request is not a Request::Inspect.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnumDebug for Request

fn type_name() -> &'static str

Returns the static name of the type used for EnumDebug-printing.

fn variant_names() -> &'static [&'static str]

Returns all variants in the trait as a list of names.

fn variant_name(&self) -> &'static str

Returns the static name of the variant.

fn variant(&self) -> EnumDebugFormatter<'_, Self>

Returns a formatter for this enum that writes its variant name.

fn variants() -> Copied<Iter<'static, &'static str>>

Returns an iterator over all variants in this enum.

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.