An RFC 2622 conformant Routing Policy Specification Language (RPSL) parser with a focus on speed and correctness.
โก๏ธ 130-250x faster than other parsers
๐ฐ Complete implementation for multiline RPSL values
๐ฌ Able to parse objects directly from whois server responses
๐ง Low memory footprint by leveraging zero-copy
๐งช Robust parsing of any valid input ensured by Property Based Tests
Usage
Parsing RPSL objects
A string containing an object in RPSL notation can be parsed to an ObjectView using the parse_object function.
use parse_object;
let role_acme = "
role: ACME Company
address: Packet Street 6
address: 128 Series of Tubes
address: Internet
email: rpsl-rs@github.com
nic-hdl: RPSL1-RIPE
source: RIPE
";
let parsed = parse_object?;
The returned ObjectView allows access to the attributes contained within in form of AttributeViews, a type that contains references to the data it represents, making the parser very memory efficient and performant, since no allocation is needed during parsing.
role: ACME Company โโโโโโโโโโโโโโโโ &"role" โโโ &"ACME Company"
address: Packet Street 6 โโโโโโโโโโโโโ &"address" โโโ &"Packet Street 6"
address: 128 Series of Tubes โโโโโโโโโ &"address" โโโ &"128 Series of Tubes"
address: Internet โโโโโโโโโโโโโโโโโโโโ &"address" โโโ &"Internet"
email: rpsl-rs@github.com โโโโโโโโโโ &"email" โโโ &"rpsl-rs@github.com"
nic-hdl: RPSL1-RIPE โโโโโโโโโโโโโโโโโโ &"nic-hdl" โโโ &"RPSL1-RIPE"
source: RIPE โโโโโโโโโโโโโโโโโโโโโโโโ &"source" โโโ &"RIPE"
println!;
ObjectView
Each AttributeView can be accessed by its index and has a name and optional value(s).
println!;
AttributeView
Since RPSL attribute values can either be single- or multiline, two different types are used to represent them. See Attribute and parse_object for more details and examples.
ObjectViews can be converted to as well as compared directly with their owned counterpart Object.
let owned = object! ;
assert_eq!;
assert_eq!;
Parsing a WHOIS server response
WHOIS servers often respond to queries by returning multiple related objects.
An example ARIN query for AS32934
will return with the requested ASNumber
object first, followed by its associated OrgName
:
To extract each individual object, the parse_whois_response function can be used to parse the response into a Vec
containing all individual ObjectViews within the response. Examples can be found in the function documentation.
Contributing
Contributions of all sizes that improve rpsl-rs
in any way, be it DX/UX, documentation, performance or other are highly appreciated.
To get started, please read the contribution guidelines. Before starting work on a new feature you would like to contribute that may impact simplicity, reliability or performance, please open an issue first.
License
The source code of this project is licensed under the MIT License. For more information, see LICENSE.