⚠️ VeridianOS Kernel Documentation - This is low-level kernel code. All functions are unsafe unless explicitly marked otherwise. no_std

Channel

Struct Channel 

Source
pub struct Channel {
Show 14 fields pub local_id: u32, pub remote_id: u32, pub channel_type: ChannelType, pub state: ChannelState, pub local_window: u32, pub remote_window: u32, pub local_max_packet: u32, pub remote_max_packet: u32, pub pty_allocated: bool, pub pty_info: Option<PtyInfo>, pub session_started: bool, pub env_vars: Vec<(Vec<u8>, Vec<u8>)>, pub eof_received: bool, pub eof_sent: bool,
}
Expand description

SSH channel

Fields§

§local_id: u32

Local channel ID

§remote_id: u32

Remote (peer) channel ID

§channel_type: ChannelType

Channel type

§state: ChannelState

Current state

§local_window: u32

Local window size remaining (how much data we can receive)

§remote_window: u32

Remote window size remaining (how much data we can send)

§local_max_packet: u32

Local maximum packet size

§remote_max_packet: u32

Remote maximum packet size

§pty_allocated: bool

Whether a PTY has been allocated

§pty_info: Option<PtyInfo>

Associated PTY info (if allocated)

§session_started: bool

Whether a shell or exec has been started

§env_vars: Vec<(Vec<u8>, Vec<u8>)>

Environment variables set via “env” requests

§eof_received: bool

EOF received from remote

§eof_sent: bool

EOF sent to remote

Implementations§

Source§

impl Channel

Source

pub fn new(local_id: u32, channel_type: ChannelType) -> Self

Create a new channel in the Opening state

Trait Implementations§

Source§

impl Clone for Channel

Source§

fn clone(&self) -> Channel

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Channel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Channel

Source§

fn eq(&self, other: &Channel) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Channel

Source§

impl StructuralPartialEq for Channel

Auto Trait Implementations§

§

impl Freeze for Channel

§

impl RefUnwindSafe for Channel

§

impl Send for Channel

§

impl Sync for Channel

§

impl Unpin for Channel

§

impl UnwindSafe for Channel

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.