Enum Value 

#[non_exhaustive]
pub enum Value {
    Integer(i32),
    OctetString(Bytes),
    Null,
    ObjectIdentifier(Oid),
    IpAddress([u8; 4]),
    Counter32(u32),
    Gauge32(u32),
    TimeTicks(u32),
    Opaque(Bytes),
    Counter64(u64),
    NoSuchObject,
    NoSuchInstance,
    EndOfMibView,
    Unknown {
        tag: u8,
        data: Bytes,
    },
}

SNMP value.

Represents all SNMP data types including SMIv2 types and exception values.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Integer(i32)

INTEGER (ASN.1 primitive, signed 32-bit)

OctetString(Bytes)

OCTET STRING (arbitrary bytes).

Per RFC 2578 (SMIv2), OCTET STRING values have a maximum size of 65535 octets. This limit is not enforced during decoding to maintain permissive parsing behavior. Applications that require strict compliance should validate size after decoding.

Null

NULL

ObjectIdentifier(Oid)

OBJECT IDENTIFIER

IpAddress([u8; 4])

IpAddress (4 bytes, big-endian)

Counter32(u32)

Counter32 (unsigned 32-bit, wrapping)

Gauge32(u32)

Gauge32 / Unsigned32 (unsigned 32-bit, non-wrapping)

TimeTicks(u32)

TimeTicks (hundredths of seconds since epoch)

Opaque(Bytes)

Opaque (legacy, arbitrary bytes)

Counter64(u64)

Counter64 (unsigned 64-bit, wrapping).

SNMPv2c/v3 only. Counter64 was introduced in SNMPv2 (RFC 2578) and is not supported in SNMPv1. When sending Counter64 values to an SNMPv1 agent, the value will be silently ignored or cause an error depending on the agent implementation.

If your application needs to support SNMPv1, avoid using Counter64 or fall back to Counter32 (with potential overflow for high-bandwidth counters).

NoSuchObject

noSuchObject exception - OID exists but no value

NoSuchInstance

noSuchInstance exception - Instance doesn’t exist

EndOfMibView

endOfMibView exception - End of MIB reached during walk

Unknown

Unknown/unrecognized value type (for forward compatibility)

Fields

tag: u8

data: Bytes

Implementations

impl Value

pub fn as_i32(&self) -> Option<i32>

Try to get as i32.

pub fn as_u32(&self) -> Option<u32>

Try to get as u32.

pub fn as_u64(&self) -> Option<u64>

Try to get as u64.

pub fn as_bytes(&self) -> Option<&[u8]>

Try to get as bytes.

pub fn as_str(&self) -> Option<&str>

Try to get as string (UTF-8).

pub fn as_oid(&self) -> Option<&Oid>

Try to get as OID.

pub fn as_ip(&self) -> Option<Ipv4Addr>

Try to get as IP address.

pub fn is_exception(&self) -> bool

Check if this is an exception value.

pub fn format_with_hint(&self, hint: &str) -> Option<String>

Format an OctetString or Opaque value using RFC 2579 DISPLAY-HINT.

Returns None if this is not an OctetString or Opaque value. On invalid hint syntax, falls back to hex encoding.

Example

use async_snmp::Value;
use bytes::Bytes;

let mac = Value::OctetString(Bytes::from_static(&[0x00, 0x1a, 0x2b, 0x3c, 0x4d, 0x5e]));
assert_eq!(mac.format_with_hint("1x:"), Some("00:1a:2b:3c:4d:5e".into()));

let integer = Value::Integer(42);
assert_eq!(integer.format_with_hint("1d"), None);

pub fn encode(&self, buf: &mut EncodeBuf)

Encode to BER.

pub fn decode(decoder: &mut Decoder) -> Result<Self>

Decode from BER.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&[u8]> for Value

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<[u8; 4]> for Value

fn from(addr: [u8; 4]) -> Self

Converts to this type from the input type.

impl From<Bytes> for Value

fn from(data: Bytes) -> Self

Converts to this type from the input type.

impl From<Ipv4Addr> for Value

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Oid> for Value

fn from(oid: Oid) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Value> for GetResult

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> 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 StructuralPartialEq for Value