Session

Struct Session 

Source
pub struct Session<C: Connection> { /* private fields */ }
Expand description

A quic-reverse session over a QUIC connection.

The session provides the main API for:

  • Initiating reverse streams to the peer
  • Accepting incoming stream requests from the peer
  • Managing the session lifecycle

§Example

use quic_reverse::{Session, Config, Role};

// Create a session as the client
let session = Session::new(connection, Role::Client, Config::default());

// Start the session (performs negotiation)
let mut handle = session.start().await?;

// Open a reverse stream
let (send, recv) = handle.open("ssh", Metadata::Empty).await?;

Implementations§

Source§

impl<C: Connection> Session<C>

Source

pub fn new(connection: C, role: Role, config: Config) -> Self

Creates a new session wrapping the given connection.

The session starts in the Init state. Call start to begin negotiation.

Source

pub fn state(&self) -> State

Returns the current session state.

Source

pub fn role(&self) -> Role

Returns the session role.

Source

pub fn negotiated_params(&self) -> Option<NegotiatedParams>

Returns the negotiated parameters, if negotiation has completed.

Source

pub fn is_ready(&self) -> bool

Returns true if the session is ready for stream operations.

Source

pub fn is_disconnected(&self) -> bool

Returns true if the connection was lost.

Source

pub fn connection(&self) -> &C

Returns a reference to the underlying connection.

Source

pub async fn start(&self) -> Result<SessionHandle<C>, Error>

Starts the session by performing negotiation.

This opens the control stream and performs the Hello/HelloAck handshake with the peer. On success, the session transitions to the Ready state.

§Errors

Returns an error if:

  • The control stream cannot be opened/accepted
  • Negotiation fails (version mismatch, timeout, etc.)
  • The session is not in the Init state

Trait Implementations§

Source§

impl<C: Connection> Clone for Session<C>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Session<C>

§

impl<C> RefUnwindSafe for Session<C>
where C: RefUnwindSafe,

§

impl<C> Send for Session<C>

§

impl<C> Sync for Session<C>

§

impl<C> Unpin for Session<C>

§

impl<C> UnwindSafe for Session<C>
where C: RefUnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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