Struct UserAgent 

pub struct UserAgent(/* private fields */);

A validated Bitcoin Core-style user agent string.

This type ensures that user agent strings follow the Bitcoin Core convention of /name:version/ and are valid at compile time rather than runtime.

Example

use bitcoin_peers_connection::UserAgent;
use std::str::FromStr;

// Valid user agent
let user_agent = UserAgent::from_str("/bitcoin-peers:0.1.0/").unwrap();
assert_eq!(user_agent.as_str(), "/bitcoin-peers:0.1.0/");

// Create with validation
let user_agent = UserAgent::new("/bitcoin-peers:0.1.0/").unwrap();

// Create from components
let user_agent = UserAgent::from_name_version("bitcoin-peers", "0.1.0");
assert_eq!(user_agent.as_str(), "/bitcoin-peers:0.1.0/");

Implementations

impl UserAgent

pub fn new<S: AsRef<str>>(user_agent: S) -> Result<Self, UserAgentError>

Creates a new validated user agent from a string.

Arguments

• user_agent - The user agent string to validate

Returns

• Ok(UserAgent) - If the user agent is valid
• Err(UserAgentError) - If the user agent format is invalid

Example

use bitcoin_peers_connection::UserAgent;

let user_agent = UserAgent::new("/bitcoin-peers:0.1.0/").unwrap();
assert_eq!(user_agent.as_str(), "/bitcoin-peers:0.1.0/");

pub fn from_name_version<S1: AsRef<str>, S2: AsRef<str>>( name: S1, version: S2, ) -> Self

Creates a user agent from name and version components.

This constructor cannot fail since it creates the string in the correct format.

Arguments

• name - The application name
• version - The application version

Returns

A validated UserAgent

Example

use bitcoin_peers_connection::UserAgent;

let user_agent = UserAgent::from_name_version("bitcoin-peers", "0.1.0");
assert_eq!(user_agent.as_str(), "/bitcoin-peers:0.1.0/");

pub fn as_str(&self) -> &str

Returns the user agent string.

Example

use bitcoin_peers_connection::UserAgent;

let user_agent = UserAgent::from_name_version("bitcoin-peers", "0.1.0");
assert_eq!(user_agent.as_str(), "/bitcoin-peers:0.1.0/");

Trait Implementations

impl AsRef<str> for UserAgent

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UserAgent

fn clone(&self) -> UserAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserAgent

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

Formats the value using the given formatter.

impl Display for UserAgent

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

Formats the value using the given formatter.

impl FromStr for UserAgent

type Err = UserAgentError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for UserAgent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UserAgent

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

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

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

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

impl Eq for UserAgent

impl StructuralPartialEq for UserAgent