Struct AccessToken 

pub struct AccessToken(/* private fields */);

An access token (Authorization: Bearer <token>).

Debug prints <redacted>; there is no Display. It serializes as a plain JSON string. No PartialEq: compare secrets in constant time (servers compare hashes). Decoding anything but a JSON string fails with a fixed message that never quotes the value.

Implementations

impl AccessToken

pub fn new(secret: impl Into<String>) -> Self

Wrap a secret.

Examples found in repository

examples/print_frames.rs (line 42)

fn main() {
    let now = UnixMillis(1_790_000_000_000);
    println!("WebSocket");
    println!("{:<22} {}", "auth (client)", WsAuth::new("example-access-token").to_message());
    show("auth.ok", &WsServerFrame::AuthOk(Some(WsAuthOk::new(UserId(42)))));
    show("auth.failed", &WsServerFrame::AuthFailed(ApiError::new(codes::TOKEN_EXPIRED, "the token expired")));
    show("request chat.join", &WsRequestFrame::call(1, JoinRoom::new("world")));
    show("answer", &WsResponseFrame::ok(1, RoomInfo::new(RoomId(12), RoomKind::Room).with_key("world")));
    show("request chat.send", &WsRequestFrame::call(2, SendMessage::new(RoomId(12), "hello")));
    show("answer", &WsResponseFrame::ok(2, SendAck::new(MessageId(981), now)));
    show("refused", &WsResponseFrame::<()>::error(3, ApiError::new(codes::NOT_A_MEMBER, "join the room first")));
    show("push chat.message", &WsPushFrame::push(ChatMessage::new(MessageId(981), RoomId(12), UserId(42), "hello", now).with_sender_name("Ada")));
    let codes: Vec<String> = CloseCode::ALL.iter().map(|c| format!("{c}{}", if c.is_permanent() { " (permanent)" } else { "" })).collect();
    println!("{:<22} {}", "close codes", codes.join(", "));

    println!();
    println!("HTTP");
    show("POST login", &LoginRequest::new("ada@example.com", "example password"));
    let tokens = TokenPair::new(
        AccessToken::new("example-access"),
        now.saturating_add_millis(3_600_000),
        RefreshToken::new("example-refresh"),
        now.saturating_add_millis(30 * 86_400_000),
    );
    show("  → 200", &AuthSession::new(Account::new(UserId(42), now).with_email("ada@example.com", true), tokens));
    show("PUT storage object", &PutObject::new(serde_json::json!({"level": 3})).if_version(ObjectVersion(2)));
    show("  → 409", &ErrorBody::new(ApiError::new(codes::VERSION_CONFLICT, "the object changed").with_details(serde_json::json!({"current_version": 3}))));
}

pub fn expose(&self) -> &str

The secret itself. Never log it.

pub fn into_inner(self) -> String

The secret, consuming the wrapper. Never log it.

pub fn is_empty(&self) -> bool

Whether it is empty.

Trait Implementations

impl Clone for AccessToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Credentials for AccessToken

Available on crate feature bevy_net_backend only.

Authorization: Bearer <token> on every HTTP request and WebSocket handshake (the client’s BearerToken does the work, including the sensitive-header flag and the refusal of a token that is not a valid header value). The handshake header authenticates the WebSocket, so no first-message auth is sent.

fn apply(&self, request: &mut OutgoingRequest)

Edit the request: add a header, a query parameter or a body field. Look at OutgoingRequest::purpose if a kind of request needs different handling.

fn ws_auth_message(&self) -> Option<String>

First-message authentication for WebSocket connections (feature ws): a text frame sent as the very first frame on every (re)connection, for backends that read the token from the first message instead of the handshake. Default: none. Never log what it returns.

impl Debug for AccessToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccessToken

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&str> for AccessToken

fn from(secret: &str) -> Self

Converts to this type from the input type.

impl From<String> for AccessToken

fn from(secret: String) -> Self

Converts to this type from the input type.

impl Serialize for AccessToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.