Struct sequoia_openpgp::parse::map::Field

pub struct Field<'a> { /* private fields */ }

Represents an entry in the map.

A field has a name returning a human-readable field name (e.g. “CTB”, or “version”), an offset into the packet, and the read data.

Implementations

impl<'a> Field<'a>

pub fn name(&self) -> &'a str

Returns the name of the field.

Note: The returned names are for display purposes only and may change in the future.

Examples

use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, PacketParserBuilder};

let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
let pp = PacketParserBuilder::from_bytes(message_data)?
    .map(true) // Enable mapping.
    .buffer_unread_content() // For the packet body.
    .build()?
    .expect("One packet, not EOF");
let map = pp.map().expect("Mapping is enabled");

assert_eq!(map.iter().nth(0).unwrap().name(), "CTB");
assert_eq!(map.iter().nth(1).unwrap().name(), "length");
assert_eq!(map.iter().nth(2).unwrap().name(), "format");
assert_eq!(map.iter().nth(3).unwrap().name(), "filename_len");
assert_eq!(map.iter().nth(4).unwrap().name(), "date");
assert_eq!(map.iter().nth(5).unwrap().name(), "body");
assert!(map.iter().nth(6).is_none());

pub fn offset(&self) -> usize

Returns the offset of the field in the packet.

Examples

use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, PacketParserBuilder};

let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
let pp = PacketParserBuilder::from_bytes(message_data)?
    .map(true) // Enable mapping.
    .buffer_unread_content() // For the packet body.
    .build()?
    .expect("One packet, not EOF");
let map = pp.map().expect("Mapping is enabled");

assert_eq!(map.iter().nth(0).unwrap().offset(), 0);
assert_eq!(map.iter().nth(1).unwrap().offset(), 1);
assert_eq!(map.iter().nth(2).unwrap().offset(), 2);
assert_eq!(map.iter().nth(3).unwrap().offset(), 3);
assert_eq!(map.iter().nth(4).unwrap().offset(), 4);
assert_eq!(map.iter().nth(5).unwrap().offset(), 8);
assert!(map.iter().nth(6).is_none());

pub fn as_bytes(&self) -> &'a [u8]

Returns the value of the field.

Examples

use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, PacketParserBuilder};

let message_data = b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.";
let pp = PacketParserBuilder::from_bytes(message_data)?
    .map(true) // Enable mapping.
    .buffer_unread_content() // For the packet body.
    .build()?
    .expect("One packet, not EOF");
let map = pp.map().expect("Mapping is enabled");

assert_eq!(map.iter().nth(0).unwrap().as_bytes(), &[0xcb]);
assert_eq!(map.iter().nth(1).unwrap().as_bytes(), &[0x12]);
assert_eq!(map.iter().nth(2).unwrap().as_bytes(), "t".as_bytes());
assert_eq!(map.iter().nth(3).unwrap().as_bytes(), &[0x00]);
assert_eq!(map.iter().nth(4).unwrap().as_bytes(),
           &[0x00, 0x00, 0x00, 0x00]);
assert_eq!(map.iter().nth(5).unwrap().as_bytes(),
           "Hello world.".as_bytes());
assert!(map.iter().nth(6).is_none());

Trait Implementations

impl<'a> Clone for Field<'a>

fn clone(&self) -> Field<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.