Skip to main content

CommonClientArgs

Struct CommonClientArgs 

Source
pub struct CommonClientArgs {
    pub timeout_secs: u64,
    pub server: String,
    pub search_addr: String,
    pub bind_addr: String,
    pub name_server: String,
    pub udp_port: u16,
    pub tcp_port: u16,
    pub debug: bool,
    pub no_broadcast: bool,
    pub authnz_user: String,
    pub authnz_host: String,
}
Expand description

Common CLI arguments shared across all PVA client tools.

Usage:

let mut common = CommonClientArgs::new();
// optionally adjust defaults before parsing:
// common.timeout_secs = 3;
{
    let mut ap = ArgumentParser::new();
    common.add_to_parser(&mut ap);
    // add tool-specific args here
    ap.parse_args_or_exit();
}
common.init_tracing();
let opts = common.into_pv_get_options("myPV".to_string())?;

Fields§

§timeout_secs: u64§server: String§search_addr: String§bind_addr: String§name_server: String§udp_port: u16§tcp_port: u16§debug: bool§no_broadcast: bool§authnz_user: String§authnz_host: String

Implementations§

Source§

impl CommonClientArgs

Source

pub fn new() -> Self

Source

pub fn add_to_parser<'a, 'b>(&'a mut self, ap: &'b mut ArgumentParser<'a>)

Register common flags on the given parser.

Short flags -w and -d are included so that tools like pvlist that historically accepted them keep working.

Source

pub fn init_tracing(&self)

Initialise the tracing_subscriber based on --debug.

Source

pub fn into_pv_get_options( self, pv_name: String, ) -> Result<PvGetOptions, Box<dyn Error>>

Convert the parsed CLI strings into a ready-to-use PvGetOptions.

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