Skip to main content

Policy

Struct Policy 

Source
pub struct Policy {
    pub allow_unsupported: bool,
    pub allow_malformed_semantics: bool,
    pub reject_invalid_nmea_checksum: bool,
    pub max_path_components: usize,
}
Expand description

Policy options applied after parsing.

Fields§

§allow_unsupported: bool

Allow semantic packets represented as unsupported.

§allow_malformed_semantics: bool

Allow semantic packets represented as malformed.

§reject_invalid_nmea_checksum: bool

Reject NMEA sentences when a present checksum does not match.

§max_path_components: usize

Maximum allowed path component count including destination.

Implementations§

Source§

impl Policy

Source

pub fn strict() -> Self

Strict policy: reject malformed semantics, unsupported formats, and long paths.

Examples found in repository?
examples/process_file.rs (line 14)
7fn main() -> std::io::Result<()> {
8    let Some(path) = std::env::args().nth(1) else {
9        eprintln!("usage: process_file <packets.aprs>");
10        std::process::exit(2);
11    };
12
13    let input = read_all_with_limit(File::open(path)?, DEFAULT_TRANSPORT_READ_LIMIT)?;
14    let mut engine = Engine::new(Policy::strict());
15
16    for packet_bytes in LineTransport::new(&input).packets() {
17        match engine.process(packet_bytes) {
18            EngineResult::Accepted { packet } => println!("{}", packet.to_json()),
19            EngineResult::Rejected { reason, .. } => eprintln!("rejected: {}", reason.code()),
20            EngineResult::ParseError(error) => eprintln!("malformed: {}", error.code()),
21        }
22    }
23
24    Ok(())
25}
More examples
Hide additional examples
examples/service_ingest.rs (line 7)
5fn main() -> Result<(), std::io::Error> {
6    let input = b"N0CALL>APRS:>service online\nN1CALL>APRS:~opaque\nbad packet\n";
7    let mut engine = Engine::new(Policy::strict());
8
9    let packets = LineTransport::new(input).packets_with_limit(MAX_PACKET_LEN)?;
10
11    for packet in packets {
12        match engine.process_event(packet) {
13            EngineEvent::Accepted(event) => {
14                println!(
15                    "event={} semantic={}",
16                    event.kind().code(),
17                    event.packet.summary().semantic
18                );
19            }
20            EngineEvent::Rejected(event) => {
21                println!(
22                    "event={} code={} remediation={}",
23                    event.kind().code(),
24                    event.diagnostic.code,
25                    event.diagnostic.remediation
26                );
27            }
28            EngineEvent::Malformed(event) => {
29                println!(
30                    "event={} code={} raw_len={} raw_truncated={} remediation={}",
31                    event.kind().code(),
32                    event.diagnostic.code,
33                    event.raw.len(),
34                    event.raw_truncated,
35                    event.diagnostic.remediation
36                );
37            }
38        }
39    }
40
41    let counters = engine.counters();
42    println!(
43        "summary accepted={} rejected={} malformed={}",
44        counters.accepted, counters.rejected, counters.malformed
45    );
46
47    Ok(())
48}
Source

pub fn permissive() -> Self

Permissive policy: accept unsupported and malformed semantic packets.

Source

pub fn evaluate( &self, packet: &ParsedPacket, semantic: &AprsData<'_>, ) -> PolicyDecision

Evaluates a parsed packet and semantic view.

Trait Implementations§

Source§

impl Clone for Policy

Source§

fn clone(&self) -> Policy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Policy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Policy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Policy

Source§

fn eq(&self, other: &Policy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Policy

Source§

impl StructuralPartialEq for Policy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.