Skip to main content

WSLContext

Struct WSLContext 

Source
pub struct WSLContext {
    pub api: &'static ApiV1,
}
Expand description

A global context for the WSL plugin API.

The WSLContext contains the API interface (ApiV1) and ensures safe, global access throughout the plugin’s lifecycle.

Fields§

§api: &'static ApiV1

The API interface used for interacting with the WSL plugin API.

Implementations§

Source§

impl WSLContext

Source

pub fn get_current() -> Option<&'static Self>

Retrieves the current WSLContext instance, if it has been initialized.

§Returns
  • Some(&'static WSLContext): If the context has been initialized.
  • None: If the context has not yet been initialized.
§Example
use wslplugins_rs::WSLContext;

if let Some(context) = WSLContext::get_current() {
    // Use the context
} else {
    eprintln!("WSL context is not initialized.");
}
Source

pub fn get_current_or_panic() -> &'static Self

Retrieves the current WSLContext instance or panics if it is not initialized.

§Panics

This function will panic if the context has not been initialized.

§Returns

A reference to the current WSLContext.

Source

pub fn init(api: &'static ApiV1) -> Option<&'static Self>

Initializes the global WSLContext with the provided ApiV1 instance.

§Arguments
  • api: The ApiV1 instance to associate with the context.
§Returns
  • Some(&'static WSLContext): If the context was successfully initialized.
  • None: If the context has already been initialized.

Trait Implementations§

Source§

impl Debug for WSLContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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