Enum ProxyV2TlvSource 

pub enum ProxyV2TlvSource<'zc, PAR: PP2TlvRestore<'zc>, EXT: PP2TlvRestore<'zc>> {
    Internal(PAR::TlvTblRes),
    External(EXT::TlvTblRes),
    Error(HaProxErr),
}

An enum which is returned by the TLV iterator. It may contain either parsed TLV or error description which occured during parsing. Normally, in case of error, the parsing should be stopped and connection dropped.

Variants

Internal(PAR::TlvTblRes)

A base implementation of the protocl.

External(EXT::TlvTblRes)

A user’s extension to the protocol.

Error(HaProxErr)

Error during parsing.

Implementations

impl<'zc, PAR: PP2TlvRestore<'zc>, EXT: PP2TlvRestore<'zc>> ProxyV2TlvSource<'zc, PAR, EXT>

pub fn take_internal(self) -> Option<PAR::TlvTblRes>

Consumes the instance returning the PP2Tlvs build-in TLV through Option. If instance os not Internal then instance will be lost.

Examples found in repository

examples/example_custom_parser.rs (line 106)

fn main() -> HaProxRes<()>
{

    let pkt_ssl = 
b"\x0d\x0a\x0d\x0a\x00\x0d\x0a\x51\x55\x49\x54\x0a\x21\x11\x00\x29\
\x7f\x00\x00\x01\x7f\x00\x00\x43\x9b\x4a\x2e\x6b\x20\x00\x0f\x01\
\x00\x00\x00\x00\x21\x00\x07\x54\x4c\x53\x76\x31\x2e\x32\xE0\x00\
\x08\x01\x02\x03\x04\x05\x06\x07\x08";

        let dec = ProxyV2Parser::<PPV2ParserZeroCopy, ProxyV2Dummy2>::try_from_slice_custom(pkt_ssl.as_slice()).unwrap();

        assert_eq!(dec.get_transport().is_ok(), true);
        assert_eq!(dec.get_transport().unwrap(), ProxyTransportFam::STREAM);

        assert_eq!(dec.get_proto_version(), ProtocolVersion::V2);
        assert_eq!(dec.get_proto_command(), HdrV2Command::PROXY);

        assert_eq!(dec.get_address_family().is_ok(), true);
        assert_eq!(dec.get_address_family().unwrap(), ProxyV2AddrType::AfInet);
        
        let addr = dec.get_address().unwrap();

        assert_eq!(addr.is_some(), true);

        let addr = addr.unwrap();
        let maddr = ProxyV2Addr::try_from(("127.0.0.1:39754", "127.0.0.67:11883")).unwrap();

        assert_eq!(addr, maddr);

        let tlv_iter = dec.get_tlvs_iter();

        assert_eq!(tlv_iter.is_some(), true);

        let mut tlv_iter = tlv_iter.unwrap();

        let type_ssl = tlv_iter.next().unwrap().take_internal().unwrap();

        assert_eq!(type_ssl.get_type(), PP2Tlvs::TYPE_SSL);
        let PP2Tlvs::TypeSsl { client, verify } = type_ssl else {panic!("wrong")};

        assert_eq!(client, PP2TlvClient::PP2_CLIENT_SSL);
        assert_eq!(verify, 0);

        // --
        let type_ssl_version = tlv_iter.next().unwrap().take_internal().unwrap();

        assert_eq!(type_ssl_version.get_type(), PP2Tlvs::TYPE_SUBTYPE_SSL_VERSION);

        let PP2Tlvs::TypeSubtypeSslVersion(ssl_version) = type_ssl_version else { panic!("wrong") };

        assert_eq!(ssl_version, "TLSv1.2");

        // ---
        let ext_type_e0 = tlv_iter.next().unwrap().take_external().unwrap();

        assert_eq!(ext_type_e0.get_type(), 0xE0);

        let ProxyV2Dummy2::SomeTlvName(arg0, arg1) = ext_type_e0 else {panic!("wrong")};

        assert_eq!(arg0, 0x01020304);
        assert_eq!(arg1, 0x05060708);


    return Ok(());
}

pub fn take_external(self) -> Option<EXT::TlvTblRes>

Consumes the instance returning the PP2Tlvs build-in TLV through Option. If instance os not External then instance will be lost.

Examples found in repository

examples/example_custom_parser.rs (line 124)

fn main() -> HaProxRes<()>
{

    let pkt_ssl = 
b"\x0d\x0a\x0d\x0a\x00\x0d\x0a\x51\x55\x49\x54\x0a\x21\x11\x00\x29\
\x7f\x00\x00\x01\x7f\x00\x00\x43\x9b\x4a\x2e\x6b\x20\x00\x0f\x01\
\x00\x00\x00\x00\x21\x00\x07\x54\x4c\x53\x76\x31\x2e\x32\xE0\x00\
\x08\x01\x02\x03\x04\x05\x06\x07\x08";

        let dec = ProxyV2Parser::<PPV2ParserZeroCopy, ProxyV2Dummy2>::try_from_slice_custom(pkt_ssl.as_slice()).unwrap();

        assert_eq!(dec.get_transport().is_ok(), true);
        assert_eq!(dec.get_transport().unwrap(), ProxyTransportFam::STREAM);

        assert_eq!(dec.get_proto_version(), ProtocolVersion::V2);
        assert_eq!(dec.get_proto_command(), HdrV2Command::PROXY);

        assert_eq!(dec.get_address_family().is_ok(), true);
        assert_eq!(dec.get_address_family().unwrap(), ProxyV2AddrType::AfInet);
        
        let addr = dec.get_address().unwrap();

        assert_eq!(addr.is_some(), true);

        let addr = addr.unwrap();
        let maddr = ProxyV2Addr::try_from(("127.0.0.1:39754", "127.0.0.67:11883")).unwrap();

        assert_eq!(addr, maddr);

        let tlv_iter = dec.get_tlvs_iter();

        assert_eq!(tlv_iter.is_some(), true);

        let mut tlv_iter = tlv_iter.unwrap();

        let type_ssl = tlv_iter.next().unwrap().take_internal().unwrap();

        assert_eq!(type_ssl.get_type(), PP2Tlvs::TYPE_SSL);
        let PP2Tlvs::TypeSsl { client, verify } = type_ssl else {panic!("wrong")};

        assert_eq!(client, PP2TlvClient::PP2_CLIENT_SSL);
        assert_eq!(verify, 0);

        // --
        let type_ssl_version = tlv_iter.next().unwrap().take_internal().unwrap();

        assert_eq!(type_ssl_version.get_type(), PP2Tlvs::TYPE_SUBTYPE_SSL_VERSION);

        let PP2Tlvs::TypeSubtypeSslVersion(ssl_version) = type_ssl_version else { panic!("wrong") };

        assert_eq!(ssl_version, "TLSv1.2");

        // ---
        let ext_type_e0 = tlv_iter.next().unwrap().take_external().unwrap();

        assert_eq!(ext_type_e0.get_type(), 0xE0);

        let ProxyV2Dummy2::SomeTlvName(arg0, arg1) = ext_type_e0 else {panic!("wrong")};

        assert_eq!(arg0, 0x01020304);
        assert_eq!(arg1, 0x05060708);


    return Ok(());
}

pub fn contains_subtype(&self) -> bool

Checks if current instance constains the subtype. For Error false is always returned.

Trait Implementations

impl<'zc, PAR: Clone + PP2TlvRestore<'zc>, EXT: Clone + PP2TlvRestore<'zc>> Clone for ProxyV2TlvSource<'zc, PAR, EXT>

where PAR::TlvTblRes: Clone, EXT::TlvTblRes: Clone,

fn clone(&self) -> ProxyV2TlvSource<'zc, PAR, EXT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'zc, PAR: Debug + PP2TlvRestore<'zc>, EXT: Debug + PP2TlvRestore<'zc>> Debug for ProxyV2TlvSource<'zc, PAR, EXT>

where PAR::TlvTblRes: Debug, EXT::TlvTblRes: Debug,

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

Formats the value using the given formatter.

impl<'zc, PAR: PartialEq + PP2TlvRestore<'zc>, EXT: PartialEq + PP2TlvRestore<'zc>> PartialEq for ProxyV2TlvSource<'zc, PAR, EXT>

where PAR::TlvTblRes: PartialEq, EXT::TlvTblRes: PartialEq,

fn eq(&self, other: &ProxyV2TlvSource<'zc, PAR, EXT>) -> 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<'zc, PAR: Eq + PP2TlvRestore<'zc>, EXT: Eq + PP2TlvRestore<'zc>> Eq for ProxyV2TlvSource<'zc, PAR, EXT>

where PAR::TlvTblRes: Eq, EXT::TlvTblRes: Eq,

impl<'zc, PAR: PP2TlvRestore<'zc>, EXT: PP2TlvRestore<'zc>> StructuralPartialEq for ProxyV2TlvSource<'zc, PAR, EXT>