Struct ldap_parser::ldap::LdapMessage

pub struct LdapMessage<'a> {
    pub message_id: MessageID,
    pub protocol_op: ProtocolOp<'a>,
    pub controls: Option<Vec<Control<'a>>>,
}

An LDAP Message according to RFC4511

Parse a single LDAP message and return a structure borrowing fields from the input buffer

use ldap_parser::FromBer;
use ldap_parser::ldap::{LdapMessage, MessageID, ProtocolOp, ProtocolOpTag};

static DATA: &[u8] = include_bytes!("../assets/message-search-request-01.bin");

let res = LdapMessage::from_ber(DATA);
match res {
    Ok((rem, msg)) => {
        assert!(rem.is_empty());
        //
        assert_eq!(msg.message_id, MessageID(4));
        assert_eq!(msg.protocol_op.tag(), ProtocolOpTag::SearchRequest);
        match msg.protocol_op {
            ProtocolOp::SearchRequest(req) => {
                assert_eq!(req.base_object.0, "dc=rccad,dc=net");
            },
            _ => panic!("Unexpected message type"),
        }
    },
    _ => panic!("LDAP parsing failed: {:?}", res),
}

Fields

message_id: MessageID

Message Identifier (32-bits unsigned integer)

The messageID of a request MUST have a non-zero value different from the messageID of any other request in progress in the same LDAP session. The zero value is reserved for the unsolicited notification message.

protocol_op: ProtocolOp<'a>

The LDAP operation from this LDAP message

controls: Option<Vec<Control<'a>>>

Message controls (optional)

Controls provide a mechanism whereby the semantics and arguments of existing LDAP operations may be extended. One or more controls may be attached to a single LDAP message. A control only affects the semantics of the message it is attached to.

Implementations

impl<'a> LdapMessage<'a>

pub fn parse(i: &'a [u8]) -> Result<'_, LdapMessage<'_>>

👎 Deprecated since 0.3.0:

Parsing functions are deprecated. Users should instead use the FromBer trait

Parse a single LDAP message and return a structure borrowing fields from the input buffer

Trait Implementations

impl<'a> Debug for LdapMessage<'a>

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

Formats the value using the given formatter.

impl<'a> FromBer<'a, LdapError> for LdapMessage<'a>

Parse a single LDAP message and return a structure borrowing fields from the input buffer

use ldap_parser::FromBer;
use ldap_parser::ldap::{LdapMessage, MessageID, ProtocolOp, ProtocolOpTag};

static DATA: &[u8] = include_bytes!("../assets/message-search-request-01.bin");

let res = LdapMessage::from_ber(DATA);
match res {
    Ok((rem, msg)) => {
        assert!(rem.is_empty());
        //
        assert_eq!(msg.message_id, MessageID(4));
        assert_eq!(msg.protocol_op.tag(), ProtocolOpTag::SearchRequest);
        match msg.protocol_op {
            ProtocolOp::SearchRequest(req) => {
                assert_eq!(req.base_object.0, "dc=rccad,dc=net");
            },
            _ => panic!("Unexpected message type"),
        }
    },
    _ => panic!("LDAP parsing failed: {:?}", res),
}

fn from_ber(bytes: &'a [u8]) -> ParseResult<'_, Self, LdapError>

Attempt to parse input bytes into a BER object

impl<'a> PartialEq<LdapMessage<'a>> for LdapMessage<'a>

fn eq(&self, other: &LdapMessage<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LdapMessage<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for LdapMessage<'a>