Enum greetd_ipc::Request

pub enum Request {
    CreateSession {
        username: String,
    },
    PostAuthMessageResponse {
        response: Option<String>,
    },
    StartSession {
        cmd: Vec<String>,
    },
    CancelSession,
}

A request from a greeter to greetd. The request type is internally tagged with the"type" field, with the type written in snake_case.

Example serialization:

{
   "type": "create_session",
   "username": "bob"
}

Variants

CreateSession

CreateSession initiates a login attempt for the given user. CreateSession returns either a Response::AuthMessage, Response::Success or Response::Failure.

If an auth message is returned, it should be answered with a Request::PostAuthMessageResponse. If a success is returned, the session can then be started with Request::StartSession.

If a login flow needs to be aborted at any point, send Request::CancelSession. Note that the session is cancelled automatically on error.

Fields of CreateSession

username: String

PostAuthMessageResponse

PostAuthMessageResponse responds to the last auth message, and returns either a Response::AuthMessage, Response::Success or Response::Failure.

If an auth message is returned, it should be answered with a Request::PostAuthMessageResponse. If a success is returned, the session can then be started with Request::StartSession.

Fields of PostAuthMessageResponse

response: Option<String>

StartSession

Start a successfully logged in session. This will fail if the session has pending messages or has encountered an error.

Fields of StartSession

cmd: Vec<String>

CancelSession

Cancel a session. This can only be done if the session has not been started. Cancel does not have to be called if an error has been encountered in its setup or login flow.

Trait Implementations

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 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.

impl SyncCodec for Request

fn read_from<T: Read>(stream: &mut T) -> Result<Self, Error>

fn write_to<T: Write>(&self, stream: &mut T) -> Result<(), Error>

impl TokioCodec for Request

fn read_from<'life0, 'async_trait, T: AsyncReadExt + Unpin + Send>(
    stream: &'life0 mut T
) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

fn write_to<'life0, 'life1, 'async_trait, T: AsyncWriteExt + Unpin + Send>(
    &'life0 self,
    stream: &'life1 mut T
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,