https://github.com/mihaigalos/url-parse

🔗 A library for parsing URLs.
https://github.com/mihaigalos/url-parse

parser rust url

Last synced: 3 days ago
JSON representation

🔗 A library for parsing URLs.

• Host: GitHub
• URL: https://github.com/mihaigalos/url-parse
• Owner: mihaigalos
• License: mit
• Created: 2022-06-23T16:27:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-23T04:56:51.000Z (8 months ago)
• Last Synced: 2024-03-23T05:39:27.477Z (8 months ago)
• Topics: parser, rust, url
• Language: Rust
• Homepage:
• Size: 170 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# url-parse

[![CI](https://github.com/mihaigalos/url-parse/actions/workflows/ci.yaml/badge.svg)](https://github.com/mihaigalos/url-parse/actions/workflows/ci.yaml)

[![CD](https://github.com/mihaigalos/url-parse/actions/workflows/cd.yaml/badge.svg)](https://github.com/mihaigalos/url-parse/actions/workflows/cd.yaml)

[![Security Audit](https://github.com/mihaigalos/url-parse/actions/workflows/audit.yaml/badge.svg)](https://github.com/mihaigalos/url-parse/actions/workflows/audit.yaml)

[![codecov](https://codecov.io/gh/mihaigalos/url-parse/branch/main/graph/badge.svg?token=crukaI8Gmf)](https://codecov.io/gh/mihaigalos/url-parse)

[![crates.io](https://img.shields.io/crates/d/url-parse.svg)](https://crates.io/crates/url-parse)

[![Documentation](https://docs.rs/url-parse/badge.svg)](https://docs.rs/url-parse)

A library for parsing URLs.

## Why?

`url-parse` provides some schemes unavailable in other url parsing crates (i.e. `sftp`, `ssh`, `s3`) and enables the user to specify custom schemes before parsing.

## Usage

### Basic

Create a new parser object with `Parser::new()`. You can then use `parser.parse(url)` which will return a public `Url` parsed structure back.

Its fields are then directly accessible:

```rust

let input = "https://user:[email protected]:443/blog/article/search?docid=720&hl=en#dayone";

let result = Parser::new(None).parse(input).unwrap();

assert_eq!(

    result,

    Url {

        scheme: Some("https".to_string()),

        user_pass: (Some("user".to_string()), Some("pass".to_string())),

        subdomain: Some("www".to_string()),

        domain: Some("example.co".to_string()),

        top_level_domain: Some("uk".to_string()),

        port: Some(443),

        path: Some(vec![

            "blog".to_string(),

            "article".to_string(),

            "search".to_string(),

        ]),

        query: Some("docid=720&hl=en#dayone".to_string()),

        anchor: Some("dayone".to_string()),

    }

)

```

### Custom schemes

Passing a `Some(HashMap)` to `Parser::new()` can be used to create custom schemes.

The hashmap is a key,value pair representing the scheme name (key) to a port and description mapping (value).

```rust

let input = "myschema://user:[email protected]/path/to/file.txt";

let mut myport_mappings = HashMap::new();

myport_mappings.insert("myschema", (8888, "My custom schema"));

let result = Parser::new(Some(myport_mappings)).parse(input).unwrap();

assert_eq!(

    result,

    Url {

        scheme: Some("myschema".to_string()),

        user_pass: (Some("user".to_string()), Some("pass".to_string())),

        subdomain: Some("www".to_string()),

        domain: Some("example.co".to_string()),

        top_level_domain: Some("uk".to_string()),

        port: Some(8888),

        path: Some(vec![

            "path".to_string(),

            "to".to_string(),

            "file.txt".to_string(),

        ]),

        query: None,

        anchor: None,

    }

);

```