Json

Struct Json 

Source
pub struct Json<T>(pub T);
Expand description

Extractor for JSON data from messages.

Automatically deserializes the message content as JSON into the specified type. The type must implement serde::Deserialize.

§Errors

Returns an error if:

  • The message is not text
  • The JSON is malformed
  • Required fields are missing
  • Type constraints are not satisfied

§Examples

§Simple Struct

use wsforge::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct LoginRequest {
    username: String,
    password: String,
}

async fn login_handler(Json(req): Json<LoginRequest>) -> Result<String> {
    // Validate credentials
    Ok(format!("Login attempt by {}", req.username))
}

§With Validation

use wsforge::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct CreateUser {
    #[serde(deserialize_with = "validate_username")]
    username: String,
    age: u8,
}

async fn create_user(Json(user): Json<CreateUser>) -> Result<String> {
    Ok(format!("Creating user: {}", user.username))
}

§Nested Structures

use wsforge::prelude::*;
use serde::Deserialize;

#[derive(Deserialize)]
struct GameState {
    player: Player,
    score: u32,
}

#[derive(Deserialize)]
struct Player {
    id: u64,
    name: String,
}

async fn update_game(Json(state): Json<GameState>) -> Result<()> {
    println!("Player {} score: {}", state.player.name, state.score);
    Ok(())
}

Tuple Fields§

§0: T

Implementations§

Source§

impl<T: Serialize> Json<T>

Source

pub fn into_message(self) -> Result<Message>

Converts this JSON extractor back into a message.

This is useful for echoing back modified data or creating responses.

§Examples
use wsforge::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize)]
struct Echo {
    text: String,
}

async fn echo_handler(Json(data): Json<Echo>) -> Result<Message> {
    Json(data).into_message()
}

Trait Implementations§

Source§

impl<T: DeserializeOwned + Send> FromMessage for Json<T>

Source§

fn from_message<'life0, 'life1, 'life2, 'life3, 'async_trait>( message: &'life0 Message, _conn: &'life1 Connection, _state: &'life2 AppState, _extensions: &'life3 Extensions, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Extracts Self from the message and context. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Json<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Json<T>
where T: RefUnwindSafe,

§

impl<T> Send for Json<T>
where T: Send,

§

impl<T> Sync for Json<T>
where T: Sync,

§

impl<T> Unpin for Json<T>
where T: Unpin,

§

impl<T> UnwindSafe for Json<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more