Struct cln_plugin::ConfiguredPlugin

source · [−]

pub struct ConfiguredPlugin<S, I, O> where
    S: Clone + Send,  { /* private fields */ }

Expand description

A plugin that has registered with the lightning daemon, and gotten its options filled, however has not yet acknowledged the init message. This is a mid-state allowing a plugin to disable itself, based on the options.

Implementations

source

impl<S, I, O> ConfiguredPlugin<S, I, O> where
 S: Send + Clone + Sync + 'static,
 I: AsyncRead + Send + Unpin + 'static,
 O: Send + AsyncWrite + Unpin + 'static,

source

pub async fn start(self) -> Result<Plugin<S>, Error>

source

pub async fn disable(self, reason: &str) -> Result<(), Error>

Abort the plugin startup. Communicate that we’re about to exit voluntarily, and this is not an error.

source

pub fn option(&self, name: &str) -> Option<Value>

Auto Trait Implementations

impl<S, I, O> !RefUnwindSafe for ConfiguredPlugin<S, I, O>

impl<S, I, O> Send for ConfiguredPlugin<S, I, O> where
I: Send,
O: Send,

impl<S, I, O> Sync for ConfiguredPlugin<S, I, O> where
 I: Sync,
 O: Send,
 S: Sync,

impl<S, I, O> Unpin for ConfiguredPlugin<S, I, O> where
I: Unpin,
S: Unpin,

impl<S, I, O> !UnwindSafe for ConfiguredPlugin<S, I, O>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct cln_plugin::ConfiguredPlugin

Implementations

impl<S, I, O> ConfiguredPlugin<S, I, O> where
    S: Send + Clone + Sync + 'static,
    I: AsyncRead + Send + Unpin + 'static,
    O: Send + AsyncWrite + Unpin + 'static,

pub async fn start(self) -> Result<Plugin<S>, Error>

pub async fn disable(self, reason: &str) -> Result<(), Error>

pub fn option(&self, name: &str) -> Option<Value>

Auto Trait Implementations

impl<S, I, O> !RefUnwindSafe for ConfiguredPlugin<S, I, O>

impl<S, I, O> Send for ConfiguredPlugin<S, I, O> where
I: Send,
O: Send,

impl<S, I, O> Sync for ConfiguredPlugin<S, I, O> where
    I: Sync,
    O: Send,
    S: Sync,

impl<S, I, O> Unpin for ConfiguredPlugin<S, I, O> where
I: Unpin,
S: Unpin,

impl<S, I, O> !UnwindSafe for ConfiguredPlugin<S, I, O>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct cln_plugin::ConfiguredPlugin

Implementations

impl<S, I, O> ConfiguredPlugin<S, I, O> where S: Send + Clone + Sync + 'static, I: AsyncRead + Send + Unpin + 'static, O: Send + AsyncWrite + Unpin + 'static,

pub async fn start(self) -> Result<Plugin<S>, Error>

pub async fn disable(self, reason: &str) -> Result<(), Error>

pub fn option(&self, name: &str) -> Option<Value>

Auto Trait Implementations

impl<S, I, O> !RefUnwindSafe for ConfiguredPlugin<S, I, O>

impl<S, I, O> Send for ConfiguredPlugin<S, I, O> where I: Send, O: Send,

impl<S, I, O> Sync for ConfiguredPlugin<S, I, O> where I: Sync, O: Send, S: Sync,

impl<S, I, O> Unpin for ConfiguredPlugin<S, I, O> where I: Unpin, S: Unpin,

impl<S, I, O> !UnwindSafe for ConfiguredPlugin<S, I, O>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<S, I, O> ConfiguredPlugin<S, I, O> where
S: Send + Clone + Sync + 'static,
I: AsyncRead + Send + Unpin + 'static,
O: Send + AsyncWrite + Unpin + 'static,

impl<S, I, O> Send for ConfiguredPlugin<S, I, O> where
I: Send,
O: Send,

impl<S, I, O> Sync for ConfiguredPlugin<S, I, O> where
I: Sync,
O: Send,
S: Sync,

impl<S, I, O> Unpin for ConfiguredPlugin<S, I, O> where
I: Unpin,
S: Unpin,

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

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

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

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

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

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