Skip to main content

GethInstance

Struct GethInstance 

Source
pub struct GethInstance { /* private fields */ }
Expand description

A geth instance. Will close the instance when dropped.

Construct this using Geth.

Implementations§

Source§

impl GethInstance

Source

pub fn host(&self) -> &str

Returns the host of this instance

Source

pub const fn port(&self) -> u16

Returns the port of this instance

Source

pub const fn p2p_port(&self) -> Option<u16>

Returns the p2p port of this instance

Source

pub const fn auth_port(&self) -> Option<u16>

Returns the auth port of this instance

Source

pub fn endpoint(&self) -> String

Returns the HTTP endpoint of this instance

Source

pub fn ws_endpoint(&self) -> String

Returns the Websocket endpoint of this instance

Source

pub fn ipc_endpoint(&self) -> String

Returns the IPC endpoint of this instance

Source

pub fn endpoint_url(&self) -> Url

Returns the HTTP endpoint url of this instance

Source

pub fn ws_endpoint_url(&self) -> Url

Returns the Websocket endpoint url of this instance

Source

pub const fn data_dir(&self) -> Option<&PathBuf>

Returns the path to this instances’ data directory

Source

pub const fn genesis(&self) -> Option<&Genesis>

Returns the genesis configuration used to configure this instance

Source

pub const fn clique_private_key(&self) -> Option<&SigningKey>

👎Deprecated:

clique support was removed in geth >=1.14

Returns the private key used to configure clique on this instance

Source

pub fn stderr(&mut self) -> Result<ChildStderr, NodeError>

Takes the stderr contained in the child process.

Stderr is available only when Geth::keep_stderr was set. This leaves None in its place, so later calls that require stderr return NodeError::NoStderr.

Source

pub fn wait_to_add_peer(&mut self, id: &str) -> Result<(), NodeError>

Blocks until geth adds the specified peer, using a 20-second deadline checked between complete stderr lines. A live process that emits no newline can block past the deadline.

Requires Geth::keep_stderr to have been set and Self::stderr not to have taken the handle.

Trait Implementations§

Source§

impl Debug for GethInstance

Source§

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

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

impl Drop for GethInstance

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1136 bytes