pub enum HexOrBase32ParseError {
+HexOrBase32ParseError in iroh::base::base32 - Rust Enum iroh::base::base32::HexOrBase32ParseError
pub enum HexOrBase32ParseError {
Base32(DecodeError),
Hex(FromHexError),
}
Expand description
Error when parsing a hex or base32 string.
Variants§
§Base32(DecodeError)
Error when decoding the base32.
§Hex(FromHexError)
Error when decoding the public key.
-Trait Implementations§
source§impl Debug for HexOrBase32ParseError
source§impl Display for HexOrBase32ParseError
source§impl Error for HexOrBase32ParseError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<DecodeError> for HexOrBase32ParseError
source§fn from(source: DecodeError) -> HexOrBase32ParseError
Converts to this type from the input type.source§impl From<FromHexError> for HexOrBase32ParseError
source§fn from(source: FromHexError) -> HexOrBase32ParseError
Converts to this type from the input type.source§impl From<HexOrBase32ParseError> for KeyParsingError
source§fn from(source: HexOrBase32ParseError) -> KeyParsingError
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for HexOrBase32ParseError
§impl RefUnwindSafe for HexOrBase32ParseError
§impl Send for HexOrBase32ParseError
§impl Sync for HexOrBase32ParseError
§impl Unpin for HexOrBase32ParseError
§impl UnwindSafe for HexOrBase32ParseError
Blanket Implementations§
Trait Implementations§
§impl Debug for HexOrBase32ParseError
§impl Display for HexOrBase32ParseError
§impl Error for HexOrBase32ParseError
§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl From<DecodeError> for HexOrBase32ParseError
§fn from(source: DecodeError) -> HexOrBase32ParseError
Converts to this type from the input type.§impl From<FromHexError> for HexOrBase32ParseError
§fn from(source: FromHexError) -> HexOrBase32ParseError
Converts to this type from the input type.§impl From<HexOrBase32ParseError> for KeyParsingError
§fn from(source: HexOrBase32ParseError) -> KeyParsingError
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for HexOrBase32ParseError
§impl RefUnwindSafe for HexOrBase32ParseError
§impl Send for HexOrBase32ParseError
§impl Sync for HexOrBase32ParseError
§impl Unpin for HexOrBase32ParseError
§impl UnwindSafe for HexOrBase32ParseError
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/base32/fn.fmt.html b/pr/2583/docs/iroh/base/base32/fn.fmt.html
index c6d288f1d97..053047d4661 100644
--- a/pr/2583/docs/iroh/base/base32/fn.fmt.html
+++ b/pr/2583/docs/iroh/base/base32/fn.fmt.html
@@ -1,2 +1,2 @@
-fmt in iroh::base::base32 - Rust pub fn fmt(bytes: impl AsRef<[u8]>) -> String
Expand description
Convert to a base32 string
+fmt in iroh::base::base32 - Rust fmt_append in iroh::base::base32 - Rust Function iroh::base::base32::fmt_append
source · pub fn fmt_append(bytes: impl AsRef<[u8]>, out: &mut String)
Expand description
Convert to a base32 string and append out out
+fmt_append in iroh::base::base32 - Rust fmt_short in iroh::base::base32 - Rust pub fn fmt_short(bytes: impl AsRef<[u8]>) -> String
Expand description
Convert to a base32 string limited to the first 10 bytes
+fmt_short in iroh::base::base32 - Rust parse_array in iroh::base::base32 - Rust Function iroh::base::base32::parse_array
source · pub fn parse_array<const N: usize>(input: &str) -> Result<[u8; N], DecodeError>
Expand description
Parse from a base32 string into a byte array
+parse_array in iroh::base::base32 - Rust Function iroh::base::base32::parse_array
pub fn parse_array<const N: usize>(input: &str) -> Result<[u8; N], DecodeError>
Expand description
Parse from a base32 string into a byte array
parse_array_hex_or_base32 in iroh::base::base32 - Rust Function iroh::base::base32::parse_array_hex_or_base32
source · pub fn parse_array_hex_or_base32<const LEN: usize>(
+parse_array_hex_or_base32 in iroh::base::base32 - Rust Function iroh::base::base32::parse_array_hex_or_base32
pub fn parse_array_hex_or_base32<const LEN: usize>(
input: &str
) -> Result<[u8; LEN], HexOrBase32ParseError>
Expand description
Parse a fixed length hex or base32 string into a byte array
For fixed length we can know the encoding by the length of the string.
diff --git a/pr/2583/docs/iroh/base/base32/fn.parse_vec.html b/pr/2583/docs/iroh/base/base32/fn.parse_vec.html
index 9cbc58698f4..496edd94cb2 100644
--- a/pr/2583/docs/iroh/base/base32/fn.parse_vec.html
+++ b/pr/2583/docs/iroh/base/base32/fn.parse_vec.html
@@ -1,2 +1,2 @@
-parse_vec in iroh::base::base32 - Rust pub fn parse_vec(input: &str) -> Result<Vec<u8>, DecodeError>
Expand description
Decode form a base32 string to a vector of bytes
+parse_vec in iroh::base::base32 - Rust iroh::base::base32 - Rust Structs§
- Decoding error
Enums§
- Decoding error kind
- Error when parsing a hex or base32 string.
Functions§
- Convert to a base32 string
- Convert to a base32 string and append out
out - Convert to a base32 string limited to the first 10 bytes
- Parse from a base32 string into a byte array
- Parse a fixed length hex or base32 string into a byte array
- Decode form a base32 string to a vector of bytes
iroh::base::base32 - Rust Structs§
- Decoding error
Enums§
- Decoding error kind
- Error when parsing a hex or base32 string.
Functions§
- Convert to a base32 string
- Convert to a base32 string and append out
out - Convert to a base32 string limited to the first 10 bytes
- Parse from a base32 string into a byte array
- Parse a fixed length hex or base32 string into a byte array
- Decode form a base32 string to a vector of bytes
Fields§
§position: usizeError position
This position is always a valid input position and represents the first encountered error.
§kind: DecodeKindError kind
-Trait Implementations§
§impl Clone for DecodeError
§fn clone(&self) -> DecodeError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DecodeError
§impl Display for DecodeError
§impl Error for DecodeError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<DecodeError> for Error
source§fn from(source: DecodeError) -> Error
Converts to this type from the input type.source§impl From<DecodeError> for HexOrBase32ParseError
source§fn from(source: DecodeError) -> HexOrBase32ParseError
Converts to this type from the input type.§impl PartialEq for DecodeError
§fn eq(&self, other: &DecodeError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
§impl Clone for DecodeError
§fn clone(&self) -> DecodeError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DecodeError
§impl Display for DecodeError
§impl Error for DecodeError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl From<DecodeError> for Error
§fn from(source: DecodeError) -> Error
Converts to this type from the input type.§impl From<DecodeError> for HexOrBase32ParseError
§fn from(source: DecodeError) -> HexOrBase32ParseError
Converts to this type from the input type.§impl PartialEq for DecodeError
§fn eq(&self, other: &DecodeError) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Copy for DecodeError
§impl Eq for DecodeError
§impl StructuralPartialEq for DecodeError
Auto Trait Implementations§
§impl Freeze for DecodeError
§impl RefUnwindSafe for DecodeError
§impl Send for DecodeError
§impl Sync for DecodeError
§impl Unpin for DecodeError
§impl UnwindSafe for DecodeError
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/hash/enum.BlobFormat.html b/pr/2583/docs/iroh/base/hash/enum.BlobFormat.html
index 524fa56682b..d562a3ab5f2 100644
--- a/pr/2583/docs/iroh/base/hash/enum.BlobFormat.html
+++ b/pr/2583/docs/iroh/base/hash/enum.BlobFormat.html
@@ -1,30 +1,30 @@
-BlobFormat in iroh::base::hash - Rust Enum iroh::base::hash::BlobFormat
source · pub enum BlobFormat {
+BlobFormat in iroh::base::hash - Rust Enum iroh::base::hash::BlobFormat
pub enum BlobFormat {
Raw,
HashSeq,
}
Expand description
A format identifier
Variants§
Implementations§
source§impl BlobFormat
Trait Implementations§
source§impl Clone for BlobFormat
source§fn clone(&self) -> BlobFormat
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for BlobFormat
source§impl Default for BlobFormat
source§fn default() -> BlobFormat
Returns the “default value” for a type. Read moresource§impl<'de> Deserialize<'de> for BlobFormat
source§fn deserialize<__D>(
+
Implementations§
§impl BlobFormat
pub const fn is_hash_seq(&self) -> bool
Is hash seq format
+Trait Implementations§
§impl Clone for BlobFormat
§fn clone(&self) -> BlobFormat
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for BlobFormat
§impl Default for BlobFormat
§fn default() -> BlobFormat
Returns the “default value” for a type. Read more§impl<'de> Deserialize<'de> for BlobFormat
§fn deserialize<__D>(
__deserializer: __D
) -> Result<BlobFormat, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for BlobFormat
source§impl Hash for BlobFormat
§impl Display for BlobFormat
§impl Hash for BlobFormat
source§impl MaxSize for BlobFormat
source§const POSTCARD_MAX_SIZE: usize = 1usize
The maximum possible size that the serialization of this
-type can have, in bytes.source§impl Ord for BlobFormat
§impl MaxSize for BlobFormat
§const POSTCARD_MAX_SIZE: usize = 1usize
The maximum possible size that the serialization of this
+type can have, in bytes.§impl Ord for BlobFormat
source§impl PartialEq for BlobFormat
§impl PartialEq for BlobFormat
§fn eq(&self, other: &BlobFormat) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl PartialOrd for BlobFormat
§impl PartialOrd for BlobFormat
§fn partial_cmp(&self, other: &BlobFormat) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for BlobFormat
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
- __S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Copy for BlobFormat
source§impl Eq for BlobFormat
source§impl StructuralPartialEq for BlobFormat
Auto Trait Implementations§
§impl Freeze for BlobFormat
§impl RefUnwindSafe for BlobFormat
§impl Send for BlobFormat
§impl Sync for BlobFormat
§impl Unpin for BlobFormat
§impl UnwindSafe for BlobFormat
Blanket Implementations§
source§impl<T> Any for Twhere
+ __S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Copy for BlobFormat
§impl Eq for BlobFormat
§impl StructuralPartialEq for BlobFormat
Auto Trait Implementations§
§impl Freeze for BlobFormat
§impl RefUnwindSafe for BlobFormat
§impl Send for BlobFormat
§impl Sync for BlobFormat
§impl Unpin for BlobFormat
§impl UnwindSafe for BlobFormat
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
source§impl<T> PeerIdentity for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> PeerIdentity for T
§impl<T> RpcError for T
§impl<T> RpcMessage for T
source§impl<T> RuleType for Twhere
diff --git a/pr/2583/docs/iroh/base/hash/index.html b/pr/2583/docs/iroh/base/hash/index.html
index 47bb37ddb1d..26ea62f9c69 100644
--- a/pr/2583/docs/iroh/base/hash/index.html
+++ b/pr/2583/docs/iroh/base/hash/index.html
@@ -1,2 +1,2 @@
-iroh::base::hash - Rust Expand description
The blake3 hash used in Iroh.
+iroh::base::hash - Rust Hash in iroh::base::hash - Rust pub struct Hash(/* private fields */);
Expand description
Hash type used throughout.
-Implementations§
source§impl Hash
sourcepub const fn from_bytes(bytes: [u8; 32]) -> Hash
Create a Hash from its raw bytes representation.
-sourcepub fn fmt_short(&self) -> String
Convert to a base32 string limited to the first 10 bytes for a friendly string
+
Hash in iroh::base::hash - Rust pub struct Hash(/* private fields */);
Expand description
Hash type used throughout.
+Implementations§
Trait Implementations§
Trait Implementations§
§impl<'de> Deserialize<'de> for Hash
§fn deserialize<D>(
deserializer: D
) -> Result<Hash, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl FromIterator<Hash> for HashSeq
§impl FromIterator<Hash> for HashSeq
source§impl MaxSize for Hash
source§const POSTCARD_MAX_SIZE: usize = 32usize
The maximum possible size that the serialization of this
-type can have, in bytes.§impl MaxSize for Hash
§const POSTCARD_MAX_SIZE: usize = 32usize
The maximum possible size that the serialization of this
+type can have, in bytes.§impl Ord for Hash
source§impl PartialOrd for Hash
§impl PartialOrd for Hash
§fn partial_cmp(&self, other: &Hash) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for Hash
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Value for Hash
§type SelfType<'a> = Hash
SelfType<’a> must be the same type as Self with all lifetimes replaced with ’a§type AsBytes<'a> = &'a [u8; 32]
source§fn fixed_width() -> Option<usize>
Width of a fixed type, or None for variable widthsource§fn from_bytes<'a>(data: &'a [u8]) -> <Hash as Value>::SelfType<'a>where
+ S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Value for Hash
§type SelfType<'a> = Hash
SelfType<’a> must be the same type as Self with all lifetimes replaced with ’a§type AsBytes<'a> = &'a [u8; 32]
§fn fixed_width() -> Option<usize>
Width of a fixed type, or None for variable width§fn from_bytes<'a>(data: &'a [u8]) -> <Hash as Value>::SelfType<'a>where
Hash: 'a,
Deserializes data
-Implementations may return a view over data, or an owned typesource§impl Copy for Hash
source§impl Eq for Hash
source§impl StructuralPartialEq for Hash
Auto Trait Implementations§
§impl Freeze for Hash
§impl RefUnwindSafe for Hash
§impl Send for Hash
§impl Sync for Hash
§impl Unpin for Hash
§impl UnwindSafe for Hash
Blanket Implementations§
§impl Copy for Hash
§impl Eq for Hash
§impl StructuralPartialEq for Hash
Auto Trait Implementations§
§impl Freeze for Hash
§impl RefUnwindSafe for Hash
§impl Send for Hash
§impl Sync for Hash
§impl Unpin for Hash
§impl UnwindSafe for Hash
Blanket Implementations§
§impl<A, T> AsBits<T> for A
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
source§impl<T> PeerIdentity for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> PeerIdentity for T
§impl<T> RpcError for T
§impl<T> RpcMessage for T
source§impl<T> RuleType for Twhere
diff --git a/pr/2583/docs/iroh/base/hash/struct.HashAndFormat.html b/pr/2583/docs/iroh/base/hash/struct.HashAndFormat.html
index c9f931ba2a8..ec96265ff90 100644
--- a/pr/2583/docs/iroh/base/hash/struct.HashAndFormat.html
+++ b/pr/2583/docs/iroh/base/hash/struct.HashAndFormat.html
@@ -1,37 +1,37 @@
-HashAndFormat in iroh::base::hash - Rust Struct iroh::base::hash::HashAndFormat
source · pub struct HashAndFormat {
+HashAndFormat in iroh::base::hash - Rust Struct iroh::base::hash::HashAndFormat
pub struct HashAndFormat {
pub hash: Hash,
pub format: BlobFormat,
}
Expand description
A hash and format pair
Fields§
§hash: HashThe hash
§format: BlobFormatThe format
-Implementations§
source§impl HashAndFormat
sourcepub fn new(hash: Hash, format: BlobFormat) -> HashAndFormat
Create a new hash and format pair.
-sourcepub fn raw(hash: Hash) -> HashAndFormat
Create a new hash and format pair, using the default (raw) format.
-sourcepub fn hash_seq(hash: Hash) -> HashAndFormat
Create a new hash and format pair, using the collection format.
-Trait Implementations§
source§impl Clone for HashAndFormat
source§fn clone(&self) -> HashAndFormat
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for HashAndFormat
source§impl<'de> Deserialize<'de> for HashAndFormat
source§fn deserialize<D>(
+
Implementations§
§impl HashAndFormat
pub fn new(hash: Hash, format: BlobFormat) -> HashAndFormat
Create a new hash and format pair.
+pub fn raw(hash: Hash) -> HashAndFormat
Create a new hash and format pair, using the default (raw) format.
+pub fn hash_seq(hash: Hash) -> HashAndFormat
Create a new hash and format pair, using the collection format.
+Trait Implementations§
§impl Clone for HashAndFormat
§fn clone(&self) -> HashAndFormat
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for HashAndFormat
§impl<'de> Deserialize<'de> for HashAndFormat
§fn deserialize<D>(
deserializer: D
) -> Result<HashAndFormat, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for HashAndFormat
source§impl From<DownloadKind> for HashAndFormat
source§fn from(value: DownloadKind) -> HashAndFormat
Converts to this type from the input type.source§impl From<HashAndFormat> for DownloadKind
source§fn from(value: HashAndFormat) -> DownloadKind
Converts to this type from the input type.source§impl From<HashAndFormat> for HashAndFormat
source§fn from(value: HashAndFormat) -> HashAndFormat
Converts to this type from the input type.source§impl FromStr for HashAndFormat
source§impl Hash for HashAndFormat
§impl Display for HashAndFormat
§impl From<DownloadKind> for HashAndFormat
§fn from(value: DownloadKind) -> HashAndFormat
Converts to this type from the input type.§impl From<HashAndFormat> for DownloadKind
§fn from(value: HashAndFormat) -> DownloadKind
Converts to this type from the input type.§impl From<HashAndFormat> for HashAndFormat
§fn from(value: HashAndFormat) -> HashAndFormat
Converts to this type from the input type.§impl FromStr for HashAndFormat
§impl Hash for HashAndFormat
source§impl MaxSize for HashAndFormat
source§const POSTCARD_MAX_SIZE: usize = 33usize
The maximum possible size that the serialization of this
-type can have, in bytes.source§impl Ord for HashAndFormat
§impl MaxSize for HashAndFormat
§const POSTCARD_MAX_SIZE: usize = 33usize
The maximum possible size that the serialization of this
+type can have, in bytes.§impl Ord for HashAndFormat
source§impl PartialEq for HashAndFormat
§impl PartialEq for HashAndFormat
§fn eq(&self, other: &HashAndFormat) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl PartialOrd for HashAndFormat
§impl PartialOrd for HashAndFormat
§fn partial_cmp(&self, other: &HashAndFormat) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for HashAndFormat
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Value for HashAndFormat
§type SelfType<'a> = HashAndFormat
SelfType<’a> must be the same type as Self with all lifetimes replaced with ’a§type AsBytes<'a> = [u8; 33]
source§fn fixed_width() -> Option<usize>
Width of a fixed type, or None for variable widthsource§fn from_bytes<'a>(data: &'a [u8]) -> <HashAndFormat as Value>::SelfType<'a>where
+ S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Value for HashAndFormat
§type SelfType<'a> = HashAndFormat
SelfType<’a> must be the same type as Self with all lifetimes replaced with ’a§type AsBytes<'a> = [u8; 33]
§fn fixed_width() -> Option<usize>
Width of a fixed type, or None for variable width§fn from_bytes<'a>(data: &'a [u8]) -> <HashAndFormat as Value>::SelfType<'a>where
HashAndFormat: 'a,
Deserializes data
-Implementations may return a view over data, or an owned type§fn as_bytes<'a, 'b>(
value: &'a <HashAndFormat as Value>::SelfType<'b>
) -> <HashAndFormat as Value>::AsBytes<'a>where
'b: 'a,
- HashAndFormat: 'a + 'b,
Serialize the value to a slicesource§impl Copy for HashAndFormat
source§impl Eq for HashAndFormat
source§impl StructuralPartialEq for HashAndFormat
Auto Trait Implementations§
§impl Freeze for HashAndFormat
§impl RefUnwindSafe for HashAndFormat
§impl Send for HashAndFormat
§impl Sync for HashAndFormat
§impl Unpin for HashAndFormat
§impl UnwindSafe for HashAndFormat
Blanket Implementations§
source§impl<T> Any for Twhere
+ HashAndFormat: 'a + 'b,
Serialize the value to a slice§impl Copy for HashAndFormat
§impl Eq for HashAndFormat
§impl StructuralPartialEq for HashAndFormat
Auto Trait Implementations§
§impl Freeze for HashAndFormat
§impl RefUnwindSafe for HashAndFormat
§impl Send for HashAndFormat
§impl Sync for HashAndFormat
§impl Unpin for HashAndFormat
§impl UnwindSafe for HashAndFormat
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
source§impl<T> PeerIdentity for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> PeerIdentity for T
§impl<T> RpcError for T
§impl<T> RpcMessage for T
source§impl<T> RuleType for Twhere
diff --git a/pr/2583/docs/iroh/base/index.html b/pr/2583/docs/iroh/base/index.html
index f38d220e573..7fdc88ed89f 100644
--- a/pr/2583/docs/iroh/base/index.html
+++ b/pr/2583/docs/iroh/base/index.html
@@ -1,2 +1,2 @@
-iroh::base - Rust Expand description
Base types and utilities for Iroh
+iroh::base - Rust KeyParsingError in iroh::base::key - Rust Enum iroh::base::key::KeyParsingError
source · pub enum KeyParsingError {
+KeyParsingError in iroh::base::key - Rust Enum iroh::base::key::KeyParsingError
pub enum KeyParsingError {
Base32(HexOrBase32ParseError),
Key(Error),
}
Variants§
§Base32(HexOrBase32ParseError)
Error when decoding the base32.
§Key(Error)
Error when decoding the public key.
-Trait Implementations§
source§impl Debug for KeyParsingError
source§impl Display for KeyParsingError
source§impl Error for KeyParsingError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for KeyParsingError
source§fn from(source: Error) -> KeyParsingError
Converts to this type from the input type.source§impl From<HexOrBase32ParseError> for KeyParsingError
source§fn from(source: HexOrBase32ParseError) -> KeyParsingError
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for KeyParsingError
§impl !RefUnwindSafe for KeyParsingError
§impl Send for KeyParsingError
§impl Sync for KeyParsingError
§impl Unpin for KeyParsingError
§impl !UnwindSafe for KeyParsingError
Blanket Implementations§
Trait Implementations§
§impl Debug for KeyParsingError
§impl Display for KeyParsingError
§impl Error for KeyParsingError
§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl From<Error> for KeyParsingError
§fn from(source: Error) -> KeyParsingError
Converts to this type from the input type.§impl From<HexOrBase32ParseError> for KeyParsingError
§fn from(source: HexOrBase32ParseError) -> KeyParsingError
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for KeyParsingError
§impl !RefUnwindSafe for KeyParsingError
§impl Send for KeyParsingError
§impl Sync for KeyParsingError
§impl Unpin for KeyParsingError
§impl !UnwindSafe for KeyParsingError
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/key/index.html b/pr/2583/docs/iroh/base/key/index.html
index 1bb1d68a50e..236a1353bb9 100644
--- a/pr/2583/docs/iroh/base/key/index.html
+++ b/pr/2583/docs/iroh/base/key/index.html
@@ -1,2 +1,2 @@
-iroh::base::key - Rust Expand description
Cryptographic key handling for iroh-net.
+iroh::base::key - Rust PublicKey in iroh::base::key - Rust pub struct PublicKey(/* private fields */);
Expand description
A public key.
+PublicKey in iroh::base::key - Rust pub struct PublicKey(/* private fields */);
Expand description
A public key.
The key itself is just a 32 byte array, but a key has associated crypto
information that is cached for performance reasons.
The cache item will be refreshed every time a crypto operation is performed,
or when a key is deserialised or created from a byte array.
Serialisation or creation from a byte array is cheap if the key is already
in the cache, but expensive if it is not.
-Implementations§
source§impl PublicKey
sourcepub fn from_bytes(bytes: &[u8; 32]) -> Result<PublicKey, Error>
Construct a PublicKey from a slice of bytes.
+Implementations§
§impl PublicKey
pub fn from_bytes(bytes: &[u8; 32]) -> Result<PublicKey, Error>
Construct a PublicKey from a slice of bytes.
§Warning
This will return a [SignatureError] if the bytes passed into this method do not represent
a valid ed25519_dalek curve point. Will never fail for bytes return from Self::as_bytes.
See [VerifyingKey::from_bytes] for details.
-sourcepub fn verify(&self, message: &[u8], signature: &Signature) -> Result<(), Error>
Verify a signature on a message with this secret key’s public key.
+pub fn verify(&self, message: &[u8], signature: &Signature) -> Result<(), Error>
Verify a signature on a message with this secret key’s public key.
§Return
Returns Ok(()) if the signature is valid, and Err otherwise.
-Trait Implementations§
Trait Implementations§
§impl<'de> Deserialize<'de> for PublicKey
§fn deserialize<D>(
deserializer: D
) -> Result<PublicKey, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more§impl FromStr for PublicKey
source§impl Hash for PublicKey
§impl Ord for PublicKey
§impl PartialEq for PublicKey
source§impl PartialOrd for PublicKey
§impl PartialOrd for PublicKey
§fn partial_cmp(&self, other: &PublicKey) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for PublicKey
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Copy for PublicKey
source§impl Eq for PublicKey
source§impl StructuralPartialEq for PublicKey
Auto Trait Implementations§
§impl Freeze for PublicKey
§impl RefUnwindSafe for PublicKey
§impl Send for PublicKey
§impl Sync for PublicKey
§impl Unpin for PublicKey
§impl UnwindSafe for PublicKey
Blanket Implementations§
§impl Copy for PublicKey
§impl Eq for PublicKey
§impl StructuralPartialEq for PublicKey
Auto Trait Implementations§
§impl Freeze for PublicKey
§impl RefUnwindSafe for PublicKey
§impl Send for PublicKey
§impl Sync for PublicKey
§impl Unpin for PublicKey
§impl UnwindSafe for PublicKey
Blanket Implementations§
§impl<A, T> AsBits<T> for A
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
source§impl<T> PeerIdentity for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> PeerIdentity for T
§impl<T> RpcError for T
§impl<T> RpcMessage for T
source§impl<T> RuleType for Twhere
diff --git a/pr/2583/docs/iroh/base/key/struct.SecretKey.html b/pr/2583/docs/iroh/base/key/struct.SecretKey.html
index 865bc76aaca..3f30f4b7b5c 100644
--- a/pr/2583/docs/iroh/base/key/struct.SecretKey.html
+++ b/pr/2583/docs/iroh/base/key/struct.SecretKey.html
@@ -1,24 +1,24 @@
-SecretKey in iroh::base::key - Rust pub struct SecretKey { /* private fields */ }
Expand description
A secret key.
-Implementations§
source§impl SecretKey
sourcepub fn generate() -> SecretKey
Generate a new SecretKey with the default randomness generator.
-sourcepub fn generate_with_rng<R>(csprng: &mut R) -> SecretKeywhere
+SecretKey in iroh::base::key - Rust pub struct SecretKey { /* private fields */ }
Expand description
A secret key.
+Implementations§
§impl SecretKey
pub fn generate_with_rng<R>(csprng: &mut R) -> SecretKeywhere
R: CryptoRngCore + ?Sized,
Generate a new SecretKey with a randomness generator.
-sourcepub fn to_openssh(&self) -> Result<Zeroizing<String>, Error>
Serialise this key to OpenSSH format.
-sourcepub fn try_from_openssh<T>(data: T) -> Result<SecretKey, Error>where
+
pub fn to_openssh(&self) -> Result<Zeroizing<String>, Error>
Serialise this key to OpenSSH format.
+pub fn try_from_openssh<T>(data: T) -> Result<SecretKey, Error>
Deserialise this key from OpenSSH format.
-sourcepub fn sign(&self, msg: &[u8]) -> Signature
Sign the given message and return a digital signature
-pub fn to_bytes(&self) -> [u8; 32]
Convert this to the bytes representing the secret part.
The public part can always be recovered.
-sourcepub fn from_bytes(bytes: &[u8; 32]) -> SecretKey
Create a secret key from its byte representation.
-Trait Implementations§
Trait Implementations§
§impl<'de> Deserialize<'de> for SecretKey
§fn deserialize<D>(
deserializer: D
) -> Result<SecretKey, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more§impl Serialize for SecretKey
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait Implementations§
§impl !Freeze for SecretKey
§impl RefUnwindSafe for SecretKey
§impl Send for SecretKey
§impl Sync for SecretKey
§impl Unpin for SecretKey
§impl UnwindSafe for SecretKey
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/key/struct.SharedSecret.html b/pr/2583/docs/iroh/base/key/struct.SharedSecret.html
index 142f36207dd..36fb01c159d 100644
--- a/pr/2583/docs/iroh/base/key/struct.SharedSecret.html
+++ b/pr/2583/docs/iroh/base/key/struct.SharedSecret.html
@@ -1,7 +1,7 @@
-SharedSecret in iroh::base::key - Rust Struct iroh::base::key::SharedSecret
source · pub struct SharedSecret(/* private fields */);
Expand description
Shared Secret.
-Implementations§
Trait Implementations§
Auto Trait Implementations§
Blanket Implementations§
source§impl<T> Any for Twhere
+SharedSecret in iroh::base::key - Rust Struct iroh::base::key::SharedSecret
pub struct SharedSecret(/* private fields */);
Expand description
Shared Secret.
+Implementations§
Trait Implementations§
Auto Trait Implementations§
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/key/type.NodeId.html b/pr/2583/docs/iroh/base/key/type.NodeId.html
index 9b62d77f88a..8e75ee33092 100644
--- a/pr/2583/docs/iroh/base/key/type.NodeId.html
+++ b/pr/2583/docs/iroh/base/key/type.NodeId.html
@@ -1,4 +1,4 @@
-NodeId in iroh::base::key - Rust pub type NodeId = PublicKey;
Expand description
The identifier for a node in the (iroh) network.
+NodeId in iroh::base::key - Rust pub type NodeId = PublicKey;
Expand description
The identifier for a node in the (iroh) network.
Each node in iroh has a unique identifier created as a cryptographic key. This can be
used to globally identify a node. Since it is also a cryptographic key it is also the
mechanism by which all traffic is always encrypted for a specific node only.
diff --git a/pr/2583/docs/iroh/base/node_addr/enum.AddrInfoOptions.html b/pr/2583/docs/iroh/base/node_addr/enum.AddrInfoOptions.html
index d76d2eeab8e..4ba9a818ebc 100644
--- a/pr/2583/docs/iroh/base/node_addr/enum.AddrInfoOptions.html
+++ b/pr/2583/docs/iroh/base/node_addr/enum.AddrInfoOptions.html
@@ -1,4 +1,4 @@
-AddrInfoOptions in iroh::base::node_addr - Rust Enum iroh::base::node_addr::AddrInfoOptions
source · pub enum AddrInfoOptions {
+AddrInfoOptions in iroh::base::node_addr - Rust Enum iroh::base::node_addr::AddrInfoOptions
pub enum AddrInfoOptions {
Id,
RelayAndAddresses,
Relay,
@@ -9,18 +9,18 @@
§RelayAndAddresses
Includes both the relay URL and the direct addresses.
§Relay
Only includes the relay URL.
§Addresses
Only includes the direct addresses.
-
Trait Implementations§
source§impl Clone for AddrInfoOptions
source§fn clone(&self) -> AddrInfoOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for AddrInfoOptions
source§impl Default for AddrInfoOptions
source§fn default() -> AddrInfoOptions
Returns the “default value” for a type. Read moresource§impl<'de> Deserialize<'de> for AddrInfoOptions
source§fn deserialize<__D>(
+
Trait Implementations§
§impl Clone for AddrInfoOptions
§fn clone(&self) -> AddrInfoOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for AddrInfoOptions
§impl Default for AddrInfoOptions
§fn default() -> AddrInfoOptions
Returns the “default value” for a type. Read more§impl<'de> Deserialize<'de> for AddrInfoOptions
§fn deserialize<__D>(
__deserializer: __D
) -> Result<AddrInfoOptions, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for AddrInfoOptions
§impl Display for AddrInfoOptions
§impl FromStr for AddrInfoOptions
source§impl PartialEq for AddrInfoOptions
source§fn eq(&self, other: &AddrInfoOptions) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<AddrInfoOptions, <AddrInfoOptions as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl PartialEq for AddrInfoOptions
§fn eq(&self, other: &AddrInfoOptions) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Serialize for AddrInfoOptions
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
- __S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Copy for AddrInfoOptions
source§impl Eq for AddrInfoOptions
source§impl StructuralPartialEq for AddrInfoOptions
Auto Trait Implementations§
§impl Freeze for AddrInfoOptions
§impl RefUnwindSafe for AddrInfoOptions
§impl Send for AddrInfoOptions
§impl Sync for AddrInfoOptions
§impl Unpin for AddrInfoOptions
§impl UnwindSafe for AddrInfoOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+ __S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Copy for AddrInfoOptions
§impl Eq for AddrInfoOptions
§impl StructuralPartialEq for AddrInfoOptions
Auto Trait Implementations§
§impl Freeze for AddrInfoOptions
§impl RefUnwindSafe for AddrInfoOptions
§impl Send for AddrInfoOptions
§impl Sync for AddrInfoOptions
§impl Unpin for AddrInfoOptions
§impl UnwindSafe for AddrInfoOptions
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/node_addr/index.html b/pr/2583/docs/iroh/base/node_addr/index.html
index 148590623cd..bd951bf381a 100644
--- a/pr/2583/docs/iroh/base/node_addr/index.html
+++ b/pr/2583/docs/iroh/base/node_addr/index.html
@@ -1,4 +1,4 @@
-iroh::base::node_addr - Rust Expand description
Addressing for iroh nodes.
+iroh::base::node_addr - Rust Expand description
Addressing for iroh nodes.
This module contains some common addressing types for iroh. A node is uniquely
identified by the NodeId but that does not make it addressable on the network layer.
For this the addition of a RelayUrl and/or direct addresses are required.
diff --git a/pr/2583/docs/iroh/base/node_addr/struct.AddrInfo.html b/pr/2583/docs/iroh/base/node_addr/struct.AddrInfo.html
index 2b082dec7d9..5aa47302be0 100644
--- a/pr/2583/docs/iroh/base/node_addr/struct.AddrInfo.html
+++ b/pr/2583/docs/iroh/base/node_addr/struct.AddrInfo.html
@@ -1,4 +1,4 @@
-AddrInfo in iroh::base::node_addr - Rust pub struct AddrInfo {
+AddrInfo in iroh::base::node_addr - Rust pub struct AddrInfo {
pub relay_url: Option<RelayUrl>,
pub direct_addresses: BTreeSet<SocketAddr>,
}
Expand description
Network paths to contact an iroh-net node.
@@ -7,26 +7,26 @@
other node, see NodeAddr for details.
Fields§
§relay_url: Option<RelayUrl>The node’s home relay url.
§direct_addresses: BTreeSet<SocketAddr>Socket addresses where the peer might be reached directly.
-Implementations§
source§impl AddrInfo
sourcepub fn apply_options(&mut self, opts: AddrInfoOptions)
Applies the options to self.
+Implementations§
§impl AddrInfo
pub fn apply_options(&mut self, opts: AddrInfoOptions)
Trait Implementations§
Trait Implementations§
§impl<'de> Deserialize<'de> for AddrInfo
§fn deserialize<__D>(
__deserializer: __D
) -> Result<AddrInfo, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more§impl Ord for AddrInfo
source§impl PartialOrd for AddrInfo
§impl PartialOrd for AddrInfo
§fn partial_cmp(&self, other: &AddrInfo) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for AddrInfo
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
- __S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Eq for AddrInfo
source§impl StructuralPartialEq for AddrInfo
Auto Trait Implementations§
§impl Freeze for AddrInfo
§impl RefUnwindSafe for AddrInfo
§impl Send for AddrInfo
§impl Sync for AddrInfo
§impl Unpin for AddrInfo
§impl UnwindSafe for AddrInfo
Blanket Implementations§
source§impl<T> Any for Twhere
+ __S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Eq for AddrInfo
§impl StructuralPartialEq for AddrInfo
Auto Trait Implementations§
§impl Freeze for AddrInfo
§impl RefUnwindSafe for AddrInfo
§impl Send for AddrInfo
§impl Sync for AddrInfo
§impl Unpin for AddrInfo
§impl UnwindSafe for AddrInfo
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/node_addr/struct.NodeAddr.html b/pr/2583/docs/iroh/base/node_addr/struct.NodeAddr.html
index 64b4ca92c6f..710be5c1f4b 100644
--- a/pr/2583/docs/iroh/base/node_addr/struct.NodeAddr.html
+++ b/pr/2583/docs/iroh/base/node_addr/struct.NodeAddr.html
@@ -1,4 +1,4 @@
-NodeAddr in iroh::base::node_addr - Rust pub struct NodeAddr {
+NodeAddr in iroh::base::node_addr - Rust pub struct NodeAddr {
pub node_id: PublicKey,
pub info: AddrInfo,
}
Expand description
Network-level addressing information for an iroh-net node.
@@ -25,38 +25,38 @@
whenever a connection to other nodes needs to be established.
Fields§
§node_id: PublicKeyThe node’s identifier.
§info: AddrInfoAddressing information to connect to Self::node_id.
-Implementations§
source§impl NodeAddr
sourcepub fn with_relay_url(self, relay_url: RelayUrl) -> NodeAddr
Adds a relay url to the node’s AddrInfo.
-sourcepub fn with_direct_addresses(
+
Implementations§
§impl NodeAddr
pub fn with_relay_url(self, relay_url: RelayUrl) -> NodeAddr
Adds a relay url to the node’s AddrInfo.
+pub fn with_direct_addresses(
self,
addresses: impl IntoIterator<Item = SocketAddr>
) -> NodeAddr
Adds the given direct addresses to the peer’s AddrInfo.
-sourcepub fn from_parts(
+
pub fn from_parts(
node_id: PublicKey,
relay_url: Option<RelayUrl>,
direct_addresses: Vec<SocketAddr>
) -> NodeAddr
Creates a new NodeAddr from its parts.
-sourcepub fn apply_options(&mut self, opts: AddrInfoOptions)
Applies the options to self.
+pub fn apply_options(&mut self, opts: AddrInfoOptions)
sourcepub fn direct_addresses(&self) -> impl Iterator<Item = &SocketAddr>
Returns the direct addresses of this peer.
-Trait Implementations§
source§impl<'de> Deserialize<'de> for NodeAddr
source§fn deserialize<__D>(
+
pub fn direct_addresses(&self) -> impl Iterator<Item = &SocketAddr>
Returns the direct addresses of this peer.
+Trait Implementations§
§impl<'de> Deserialize<'de> for NodeAddr
§fn deserialize<__D>(
__deserializer: __D
) -> Result<NodeAddr, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more§impl Ord for NodeAddr
source§impl PartialOrd for NodeAddr
§impl PartialOrd for NodeAddr
§fn partial_cmp(&self, other: &NodeAddr) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for NodeAddr
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
- __S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Eq for NodeAddr
source§impl StructuralPartialEq for NodeAddr
Auto Trait Implementations§
§impl Freeze for NodeAddr
§impl RefUnwindSafe for NodeAddr
§impl Send for NodeAddr
§impl Sync for NodeAddr
§impl Unpin for NodeAddr
§impl UnwindSafe for NodeAddr
Blanket Implementations§
source§impl<T> Any for Twhere
+ __S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Eq for NodeAddr
§impl StructuralPartialEq for NodeAddr
Auto Trait Implementations§
§impl Freeze for NodeAddr
§impl RefUnwindSafe for NodeAddr
§impl Send for NodeAddr
§impl Sync for NodeAddr
§impl Unpin for NodeAddr
§impl UnwindSafe for NodeAddr
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/node_addr/struct.RelayUrl.html b/pr/2583/docs/iroh/base/node_addr/struct.RelayUrl.html
index ad92fac12ae..e2c310ed16a 100644
--- a/pr/2583/docs/iroh/base/node_addr/struct.RelayUrl.html
+++ b/pr/2583/docs/iroh/base/node_addr/struct.RelayUrl.html
@@ -1,4 +1,4 @@
-RelayUrl in iroh::base::node_addr - Rust pub struct RelayUrl(/* private fields */);
Expand description
A URL identifying a relay server.
+RelayUrl in iroh::base::node_addr - Rust pub struct RelayUrl(/* private fields */);
Trait Implementations§
Trait Implementations§
§impl Deref for RelayUrl
source§impl<'de> Deserialize<'de> for RelayUrl
source§fn deserialize<__D>(
+
§impl<'de> Deserialize<'de> for RelayUrl
§fn deserialize<__D>(
__deserializer: __D
) -> Result<RelayUrl, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more§impl FromStr for RelayUrl
Support for parsing strings directly.
If you need more control over the error first create a Url and use RelayUrl::from
instead.
-source§impl Hash for RelayUrl
§impl Ord for RelayUrl
source§impl PartialOrd for RelayUrl
§impl PartialOrd for RelayUrl
§fn partial_cmp(&self, other: &RelayUrl) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more§impl Serialize for RelayUrl
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
- __S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Eq for RelayUrl
source§impl StructuralPartialEq for RelayUrl
Auto Trait Implementations§
§impl Freeze for RelayUrl
§impl RefUnwindSafe for RelayUrl
§impl Send for RelayUrl
§impl Sync for RelayUrl
§impl Unpin for RelayUrl
§impl UnwindSafe for RelayUrl
Blanket Implementations§
source§impl<T> Any for Twhere
+ __S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Eq for RelayUrl
§impl StructuralPartialEq for RelayUrl
Auto Trait Implementations§
§impl Freeze for RelayUrl
§impl RefUnwindSafe for RelayUrl
§impl Send for RelayUrl
§impl Sync for RelayUrl
§impl Unpin for RelayUrl
§impl UnwindSafe for RelayUrl
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/rpc/index.html b/pr/2583/docs/iroh/base/rpc/index.html
index 6958e159a05..7cbba3416a7 100644
--- a/pr/2583/docs/iroh/base/rpc/index.html
+++ b/pr/2583/docs/iroh/base/rpc/index.html
@@ -1 +1 @@
-iroh::base::rpc - Rust iroh::base::rpc - Rust RpcError in iroh::base::rpc - Rust pub struct RpcError(/* private fields */);
Expand description
A serializable error type for use in RPC responses.
-Trait Implementations§
source§impl<'de> Deserialize<'de> for RpcError
source§fn deserialize<__D>(
+RpcError in iroh::base::rpc - Rust pub struct RpcError(/* private fields */);
Expand description
A serializable error type for use in RPC responses.
+Trait Implementations§
§impl<'de> Deserialize<'de> for RpcError
§fn deserialize<__D>(
__deserializer: __D
) -> Result<RpcError, <__D as Deserializer<'de>>::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Error for RpcError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl Error for RpcError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl Serialize for RpcError
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
diff --git a/pr/2583/docs/iroh/base/rpc/type.RpcResult.html b/pr/2583/docs/iroh/base/rpc/type.RpcResult.html
index b48cc36cef6..4b1e9f112cf 100644
--- a/pr/2583/docs/iroh/base/rpc/type.RpcResult.html
+++ b/pr/2583/docs/iroh/base/rpc/type.RpcResult.html
@@ -1,4 +1,4 @@
-RpcResult in iroh::base::rpc - Rust pub type RpcResult<T> = Result<T, RpcError>;
Expand description
A serializable result type for use in RPC responses.
+RpcResult in iroh::base::rpc - Rust pub type RpcResult<T> = Result<T, RpcError>;
Expand description
A serializable result type for use in RPC responses.
Aliased Type§
enum RpcResult<T> {
Ok(T),
Err(RpcError),
diff --git a/pr/2583/docs/iroh/base/ticket/enum.Error.html b/pr/2583/docs/iroh/base/ticket/enum.Error.html
index a0d8798e9c8..c2e26eb82d0 100644
--- a/pr/2583/docs/iroh/base/ticket/enum.Error.html
+++ b/pr/2583/docs/iroh/base/ticket/enum.Error.html
@@ -1,4 +1,4 @@
-Error in iroh::base::ticket - Rust pub enum Error {
+Error in iroh::base::ticket - Rust §Postcard(Error)
This looks like a ticket, but postcard deserialization failed.
§Encoding(DecodeError)
This looks like a ticket, but base32 decoding failed.
§Verify(&'static str)
Verification of the deserialized bytes failed.
-
Trait Implementations§
source§impl Error for Error
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<DecodeError> for Error
source§fn from(source: DecodeError) -> Error
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
§impl Error for Error
§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()§impl From<DecodeError> for Error
§fn from(source: DecodeError) -> Error
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/ticket/index.html b/pr/2583/docs/iroh/base/ticket/index.html
index 18e6505f5a6..714c239d2e3 100644
--- a/pr/2583/docs/iroh/base/ticket/index.html
+++ b/pr/2583/docs/iroh/base/ticket/index.html
@@ -1,3 +1,3 @@
-iroh::base::ticket - Rust Structs§
- A token containing everything to get a file from the provider.
- A token containing everything to get a file from the provider.
Enums§
- An error deserializing an iroh ticket.
Traits§
- A ticket is a serializable object that combines all information required
+
iroh::base::ticket - Rust Structs§
- A token containing everything to get a file from the provider.
- A token containing everything to get a file from the provider.
Enums§
- An error deserializing an iroh ticket.
Traits§
- A ticket is a serializable object that combines all information required
for an operation. E.g. an iroh blob ticket would contain the hash of the
data as well as information about how to reach the provider.
BlobTicket in iroh::base::ticket - Rust Struct iroh::base::ticket::BlobTicket
source · pub struct BlobTicket { /* private fields */ }
Expand description
A token containing everything to get a file from the provider.
+BlobTicket in iroh::base::ticket - Rust Struct iroh::base::ticket::BlobTicket
pub struct BlobTicket { /* private fields */ }
Expand description
A token containing everything to get a file from the provider.
It is a single item which can be easily serialized and deserialized.
-Implementations§
source§impl BlobTicket
Implementations§
§impl BlobTicket
pub fn new(
node: NodeAddr,
hash: Hash,
format: BlobFormat
) -> Result<BlobTicket, Error>
Creates a new ticket.
-sourcepub fn format(&self) -> BlobFormat
The BlobFormat for this ticket.
-sourcepub fn recursive(&self) -> bool
True if the ticket is for a collection and should retrieve all blobs in it.
-sourcepub fn into_parts(self) -> (NodeAddr, Hash, BlobFormat)
Get the contents of the ticket, consuming it.
-Trait Implementations§
source§impl Clone for BlobTicket
source§fn clone(&self) -> BlobTicket
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for BlobTicket
source§impl<'de> Deserialize<'de> for BlobTicket
source§fn deserialize<D>(
+
pub fn format(&self) -> BlobFormat
The BlobFormat for this ticket.
+pub fn recursive(&self) -> bool
True if the ticket is for a collection and should retrieve all blobs in it.
+pub fn into_parts(self) -> (NodeAddr, Hash, BlobFormat)
Get the contents of the ticket, consuming it.
+Trait Implementations§
§impl Clone for BlobTicket
§fn clone(&self) -> BlobTicket
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for BlobTicket
§impl<'de> Deserialize<'de> for BlobTicket
§fn deserialize<D>(
deserializer: D
) -> Result<BlobTicket, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for BlobTicket
source§impl FromStr for BlobTicket
source§impl PartialEq for BlobTicket
§impl Display for BlobTicket
§impl FromStr for BlobTicket
§impl PartialEq for BlobTicket
§fn eq(&self, other: &BlobTicket) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Serialize for BlobTicket
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Serialize this value into the given Serde serializer. Read moresource§impl Ticket for BlobTicket
source§fn from_bytes(bytes: &[u8]) -> Result<BlobTicket, Error>
Deserialize from the base32 string representation bytes.source§impl Eq for BlobTicket
source§impl StructuralPartialEq for BlobTicket
Auto Trait Implementations§
§impl Freeze for BlobTicket
§impl RefUnwindSafe for BlobTicket
§impl Send for BlobTicket
§impl Sync for BlobTicket
§impl Unpin for BlobTicket
§impl UnwindSafe for BlobTicket
Blanket Implementations§
source§impl<T> Any for Twhere
+ S: Serializer,
Serialize this value into the given Serde serializer. Read more§impl Ticket for BlobTicket
§fn from_bytes(bytes: &[u8]) -> Result<BlobTicket, Error>
Deserialize from the base32 string representation bytes.§fn deserialize(str: &str) -> Result<Self, Error>
Deserialize from a string.§impl Eq for BlobTicket
§impl StructuralPartialEq for BlobTicket
Auto Trait Implementations§
§impl Freeze for BlobTicket
§impl RefUnwindSafe for BlobTicket
§impl Send for BlobTicket
§impl Sync for BlobTicket
§impl Unpin for BlobTicket
§impl UnwindSafe for BlobTicket
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
diff --git a/pr/2583/docs/iroh/base/ticket/struct.NodeTicket.html b/pr/2583/docs/iroh/base/ticket/struct.NodeTicket.html
index 3c261857d7c..c62adeebca7 100644
--- a/pr/2583/docs/iroh/base/ticket/struct.NodeTicket.html
+++ b/pr/2583/docs/iroh/base/ticket/struct.NodeTicket.html
@@ -1,17 +1,17 @@
-NodeTicket in iroh::base::ticket - Rust Struct iroh::base::ticket::NodeTicket
source · pub struct NodeTicket { /* private fields */ }
Expand description
A token containing everything to get a file from the provider.
+NodeTicket in iroh::base::ticket - Rust Struct iroh::base::ticket::NodeTicket
pub struct NodeTicket { /* private fields */ }
Expand description
A token containing everything to get a file from the provider.
It is a single item which can be easily serialized and deserialized.
-Implementations§
source§impl NodeTicket
sourcepub fn