SeanOMik
/
magnet-url-rs
mirror of https://github.com/SeanOMik/magnet-url-rs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
magnet-url-rs/README.md

83 lines
4.4 KiB
Markdown
Raw Normal View History

Added build status from Travis CI There's been a lot of commits because of the mistakes I've made on this repo. This should be the last one.
2021-02-16 20:10:06 +00:00
[![Build Status](https://www.travis-ci.com/billyb2/parse-magnet-rs.svg?branch=main)](https://www.travis-ci.com/billyb2/parse-magnet-rs)
Minor documentation improvements I got some feedback from Redditors, and addd some information as to what a magnet url is, and why a magnet-url parser is useful
2021-02-17 13:35:23 +00:00
# What is a magnet url
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
A magnet is a URI scheme that identifies files by their hash,
normally used in peer to peer file sharing networks (like
Bittorrent). Basically, a magnet link identifies a torrent you
want to download, and tells the torrent client how to download
it. They make it very easy to share files over the internet,
and use a combination of DHT and trackers to tell your torrent
client where other peers who can share the file with you are.
Minor documentation improvements I got some feedback from Redditors, and addd some information as to what a magnet url is, and why a magnet-url parser is useful
2021-02-17 13:35:23 +00:00
# Why is magnet_url
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
While working on a side project, I realized that I had the
misfortune of trying to get the component parts of a magnet-url
and then do further processing of them. I quickly wrote some
Regex for it, but then I realized that this would be really
useful for other projects that are dealing with torrents in
Rust. By making it modifiable, too, it would allow for the
creation of custom magnet links, which would also be useful for
torrent based projects.
Minor documentation improvements I got some feedback from Redditors, and addd some information as to what a magnet url is, and why a magnet-url parser is useful
2021-02-17 13:35:23 +00:00
# Why use magnet_url
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
magnet_url has the goal of, as you may have guessed, parsing the parts of magnets. It does
this using some relatively simple regexes. The crate is designed to be very simple and efficient,
with a lot of flexibility. It's also designed to be relatively easy to handle errors, and
Fixed some typos Just for a specific reddit user jaja. Also did some minor changes with how the string parsing is done.
2021-02-17 23:18:36 +00:00
modification of its source is greatly encouraged through documentation and its license.
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
## How to use this crate
Parsing a magnet is very simple:
```
Fixed documentation examples I put one colon instead of two
2021-02-16 20:13:13 +00:00
use magnet_url::Magnet;
More documentation bug fixes You can't use dashes in variable names(?)
2021-02-16 20:18:56 +00:00
let magneturl = Magnet::new("magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel&tr=udp%3A%2F%2Fexplodie.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.empire-js.us%3A1337&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2F&xs=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel.torrent");
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
```
This returns the Magnet struct, which is made up of the fields listed below this section. To
access one of these fields is also very simple:
```
Fixed documentation examples I put one colon instead of two
2021-02-16 20:13:13 +00:00
use magnet_url::Magnet;
More documentation bug fixes You can't use dashes in variable names(?)
2021-02-16 20:18:56 +00:00
let magneturl = Magnet::new("magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel&tr=udp%3A%2F%2Fexplodie.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.empire-js.us%3A1337&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2F&xs=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel.torrent");
println!("{:?}", magneturl.dn);
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
```
If you'd like to modify parts of the magnet_url to customize it, that can be done as well!
```
Fixed documentation examples I put one colon instead of two
2021-02-16 20:13:13 +00:00
use magnet_url::Magnet;
More documentation bug fixes You can't use dashes in variable names(?)
2021-02-16 20:18:56 +00:00
let mut magneturl = Magnet::new("magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel&tr=udp%3A%2F%2Fexplodie.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.empire-js.us%3A1337&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2F&xs=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel.torrent");
println!("{:?}", magneturl.dn);
magneturl.dn = String::from("hello_world");
println!("{:?}", magneturl.dn);
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
```
In fact, you can construct your own magnet url as well, as long as you fill in all the
parameters!
```
Fixed documentation examples I put one colon instead of two
2021-02-16 20:13:13 +00:00
use magnet_url::Magnet;
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
//Note, this magnet won't actually download, sorry :/
Magnet {
dn: "hello_world".to_string(),
hash_type: "sha1".to_string(),
xt: "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed".to_string(),
xl: 1234567890,
tr:
{
let mut tr_vec = Vec::new();
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
tr_vec.push("https://example.com/".to_string());
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
tr_vec
},
kt: "cool+stuff".to_string(),
ws: String::new(),
acceptable_source: String::new(),
mt: String::new(),
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
xs: String::new(),
Added Magnet Parsing Code The ode basically uses a ton of regex checks to find specific parts of the magnet url, and then chops it up into the Magnet struct.
2021-02-16 18:45:20 +00:00
};
Library now panics! on invalid magnet url Another helpful redditor warned me about the dangers of not validating that the URL given is a magnet url. Unfortuanetly, I can't just change everything to use Options and Errors, so I'm making the fix of having the library just panic instead, since that would make it still backwards compatible. This will be changed in version 2.0.0
2021-02-17 15:15:02 +00:00
```
Invalid magnet url's will result in a panic! (This will be changed to an error in v2.0.0
```#[should_panic]
use magnet_url::Magnet;
let _magnet_link = Magnet::new("https://example.com");
```