Struct websocket::header::Link

pub struct Link { /* fields omitted */ }

The Link header, defined in RFC5988

ABNF

Link           = "Link" ":" #link-value
link-value     = "<" URI-Reference ">" *( ";" link-param )
link-param     = ( ( "rel" "=" relation-types )
               | ( "anchor" "=" <"> URI-Reference <"> )
               | ( "rev" "=" relation-types )
               | ( "hreflang" "=" Language-Tag )
               | ( "media" "=" ( MediaDesc | ( <"> MediaDesc <"> ) ) )
               | ( "title" "=" quoted-string )
               | ( "title*" "=" ext-value )
               | ( "type" "=" ( media-type | quoted-mt ) )
               | ( link-extension ) )
link-extension = ( parmname [ "=" ( ptoken | quoted-string ) ] )
               | ( ext-name-star "=" ext-value )
ext-name-star  = parmname "*" ; reserved for RFC2231-profiled
; extensions.  Whitespace NOT
; allowed in between.
ptoken         = 1*ptokenchar
ptokenchar     = "!" | "#" | "$" | "%" | "&" | "'" | "("
               | ")" | "*" | "+" | "-" | "." | "/" | DIGIT
               | ":" | "<" | "=" | ">" | "?" | "@" | ALPHA
               | "[" | "]" | "^" | "_" | "`" | "{" | "|"
               | "}" | "~"
media-type     = type-name "/" subtype-name
quoted-mt      = <"> media-type <">
relation-types = relation-type
               | <"> relation-type *( 1*SP relation-type ) <">
relation-type  = reg-rel-type | ext-rel-type
reg-rel-type   = LOALPHA *( LOALPHA | DIGIT | "." | "-" )
ext-rel-type   = URI

Example values

Link: <http://example.com/TheBook/chapter2>; rel="previous"; title="previous chapter"

Link: </TheBook/chapter2>; rel="previous"; title*=UTF-8'de'letztes%20Kapitel, </TheBook/chapter4>; rel="next"; title*=UTF-8'de'n%c3%a4chstes%20Kapitel

Examples

use hyper::header::{Headers, Link, LinkValue, RelationType};

let link_value = LinkValue::new("http://example.com/TheBook/chapter2")
    .push_rel(RelationType::Previous)
    .set_title("previous chapter");

let mut headers = Headers::new();
headers.set(
    Link::new(vec![link_value])
);

Methods

impl Link

pub fn new(link_values: Vec<LinkValue>) -> Link

Create Link from a Vec<LinkValue>.

pub fn values(&self) -> &[LinkValue]

Get the Link header's LinkValues.

pub fn push_value(&mut self, link_value: LinkValue)

Add a LinkValue instance to the Link header's values.

Trait Implementations

impl Debug for Link

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

Formats the value using the given formatter.

impl Display for Link

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

Formats the value using the given formatter.

impl FromStr for Link

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Link, Error>

Parses a string s to return a value of this type.

impl PartialEq<Link> for Link

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl HeaderFormat for Link

fn fmt_header(&self, f: &mut Formatter) -> Result<(), Error>

Format a header to be output into a TcpStream.

impl Header for Link

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &[Vec<u8>]) -> Result<Link, Error>

Parse a header from a raw stream of bytes.

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.