Struct hyper::header::Referer [−][src]
pub struct Referer(pub String);
Referer
header, defined in
RFC7231
The Referer
[sic] header field allows the user agent to specify a
URI reference for the resource from which the target URI was obtained
(i.e., the "referrer", though the field name is misspelled). A user
agent MUST NOT include the fragment and userinfo components of the
URI reference, if any, when generating the Referer field value.
ABNF
Referer = absolute-URI / partial-URI
Example values
http://www.example.org/hypertext/Overview.html
Examples
use hyper::header::{Headers, Referer}; let mut headers = Headers::new(); headers.set(Referer("/People.html#tim".to_owned()));
use hyper::header::{Headers, Referer}; let mut headers = Headers::new(); headers.set(Referer("http://www.example.com/index.html".to_owned()));
Methods from Deref<Target = String>
pub fn as_str(&self) -> &str
1.7.0[src]
pub fn as_str(&self) -> &str
Extracts a string slice containing the entire string.
Examples
Basic usage:
let s = String::from("foo"); assert_eq!("foo", s.as_str());
pub fn as_mut_str(&mut self) -> &mut str
1.7.0[src]
pub fn as_mut_str(&mut self) -> &mut str
Converts a String
into a mutable string slice.
Examples
Basic usage:
let mut s = String::from("foobar"); let s_mut_str = s.as_mut_str(); s_mut_str.make_ascii_uppercase(); assert_eq!("FOOBAR", s_mut_str);
pub fn push_str(&mut self, string: &str)
1.0.0[src]
pub fn push_str(&mut self, string: &str)
Appends a given string slice onto the end of this String
.
Examples
Basic usage:
let mut s = String::from("foo"); s.push_str("bar"); assert_eq!("foobar", s);
pub fn capacity(&self) -> usize
1.0.0[src]
pub fn capacity(&self) -> usize
Returns this String
's capacity, in bytes.
Examples
Basic usage:
let s = String::with_capacity(10); assert!(s.capacity() >= 10);
pub fn reserve(&mut self, additional: usize)
1.0.0[src]
pub fn reserve(&mut self, additional: usize)
Ensures that this String
's capacity is at least additional
bytes
larger than its length.
The capacity may be increased by more than additional
bytes if it
chooses, to prevent frequent reallocations.
If you do not want this "at least" behavior, see the reserve_exact
method.
Panics
Panics if the new capacity overflows usize
.
Examples
Basic usage:
let mut s = String::new(); s.reserve(10); assert!(s.capacity() >= 10);
This may not actually increase the capacity:
let mut s = String::with_capacity(10); s.push('a'); s.push('b'); // s now has a length of 2 and a capacity of 10 assert_eq!(2, s.len()); assert_eq!(10, s.capacity()); // Since we already have an extra 8 capacity, calling this... s.reserve(8); // ... doesn't actually increase. assert_eq!(10, s.capacity());
pub fn reserve_exact(&mut self, additional: usize)
1.0.0[src]
pub fn reserve_exact(&mut self, additional: usize)
Ensures that this String
's capacity is additional
bytes
larger than its length.
Consider using the reserve
method unless you absolutely know
better than the allocator.
Panics
Panics if the new capacity overflows usize
.
Examples
Basic usage:
let mut s = String::new(); s.reserve_exact(10); assert!(s.capacity() >= 10);
This may not actually increase the capacity:
let mut s = String::with_capacity(10); s.push('a'); s.push('b'); // s now has a length of 2 and a capacity of 10 assert_eq!(2, s.len()); assert_eq!(10, s.capacity()); // Since we already have an extra 8 capacity, calling this... s.reserve_exact(8); // ... doesn't actually increase. assert_eq!(10, s.capacity());
pub fn try_reserve(
&mut self,
additional: usize
) -> Result<(), CollectionAllocErr>
[src]
pub fn try_reserve(
&mut self,
additional: usize
) -> Result<(), CollectionAllocErr>
🔬 This is a nightly-only experimental API. (try_reserve
)
new API
Tries to reserve capacity for at least additional
more elements to be inserted
in the given String
. The collection may reserve more space to avoid
frequent reallocations. After calling reserve
, capacity will be
greater than or equal to self.len() + additional
. Does nothing if
capacity is already sufficient.
Errors
If the capacity overflows, or the allocator reports a failure, then an error is returned.
Examples
#![feature(try_reserve)] use std::collections::CollectionAllocErr; fn process_data(data: &str) -> Result<String, CollectionAllocErr> { let mut output = String::new(); // Pre-reserve the memory, exiting if we can't output.try_reserve(data.len())?; // Now we know this can't OOM in the middle of our complex work output.push_str(data); Ok(output) }
pub fn try_reserve_exact(
&mut self,
additional: usize
) -> Result<(), CollectionAllocErr>
[src]
pub fn try_reserve_exact(
&mut self,
additional: usize
) -> Result<(), CollectionAllocErr>
🔬 This is a nightly-only experimental API. (try_reserve
)
new API
Tries to reserves the minimum capacity for exactly additional
more elements to
be inserted in the given String
. After calling reserve_exact
,
capacity will be greater than or equal to self.len() + additional
.
Does nothing if the capacity is already sufficient.
Note that the allocator may give the collection more space than it
requests. Therefore capacity can not be relied upon to be precisely
minimal. Prefer reserve
if future insertions are expected.
Errors
If the capacity overflows, or the allocator reports a failure, then an error is returned.
Examples
#![feature(try_reserve)] use std::collections::CollectionAllocErr; fn process_data(data: &str) -> Result<String, CollectionAllocErr> { let mut output = String::new(); // Pre-reserve the memory, exiting if we can't output.try_reserve(data.len())?; // Now we know this can't OOM in the middle of our complex work output.push_str(data); Ok(output) }
pub fn shrink_to_fit(&mut self)
1.0.0[src]
pub fn shrink_to_fit(&mut self)
Shrinks the capacity of this String
to match its length.
Examples
Basic usage:
let mut s = String::from("foo"); s.reserve(100); assert!(s.capacity() >= 100); s.shrink_to_fit(); assert_eq!(3, s.capacity());
pub fn shrink_to(&mut self, min_capacity: usize)
[src]
pub fn shrink_to(&mut self, min_capacity: usize)
🔬 This is a nightly-only experimental API. (shrink_to
)
new API
Shrinks the capacity of this String
with a lower bound.
The capacity will remain at least as large as both the length and the supplied value.
Panics if the current capacity is smaller than the supplied minimum capacity.
Examples
#![feature(shrink_to)] let mut s = String::from("foo"); s.reserve(100); assert!(s.capacity() >= 100); s.shrink_to(10); assert!(s.capacity() >= 10); s.shrink_to(0); assert!(s.capacity() >= 3);
pub fn push(&mut self, ch: char)
1.0.0[src]
pub fn push(&mut self, ch: char)
Appends the given char
to the end of this String
.
Examples
Basic usage:
let mut s = String::from("abc"); s.push('1'); s.push('2'); s.push('3'); assert_eq!("abc123", s);
pub fn as_bytes(&self) -> &[u8]
1.0.0[src]
pub fn as_bytes(&self) -> &[u8]
Returns a byte slice of this String
's contents.
The inverse of this method is from_utf8
.
Examples
Basic usage:
let s = String::from("hello"); assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());
pub fn truncate(&mut self, new_len: usize)
1.0.0[src]
pub fn truncate(&mut self, new_len: usize)
Shortens this String
to the specified length.
If new_len
is greater than the string's current length, this has no
effect.
Note that this method has no effect on the allocated capacity of the string
Panics
Panics if new_len
does not lie on a char
boundary.
Examples
Basic usage:
let mut s = String::from("hello"); s.truncate(2); assert_eq!("he", s);
pub fn pop(&mut self) -> Option<char>
1.0.0[src]
pub fn pop(&mut self) -> Option<char>
Removes the last character from the string buffer and returns it.
Returns None
if this String
is empty.
Examples
Basic usage:
let mut s = String::from("foo"); assert_eq!(s.pop(), Some('o')); assert_eq!(s.pop(), Some('o')); assert_eq!(s.pop(), Some('f')); assert_eq!(s.pop(), None);
pub fn remove(&mut self, idx: usize) -> char
1.0.0[src]
pub fn remove(&mut self, idx: usize) -> char
Removes a char
from this String
at a byte position and returns it.
This is an O(n)
operation, as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than or equal to the String
's length,
or if it does not lie on a char
boundary.
Examples
Basic usage:
let mut s = String::from("foo"); assert_eq!(s.remove(0), 'f'); assert_eq!(s.remove(1), 'o'); assert_eq!(s.remove(0), 'o');
pub fn retain<F>(&mut self, f: F) where
F: FnMut(char) -> bool,
1.26.0[src]
pub fn retain<F>(&mut self, f: F) where
F: FnMut(char) -> bool,
Retains only the characters specified by the predicate.
In other words, remove all characters c
such that f(c)
returns false
.
This method operates in place and preserves the order of the retained
characters.
Examples
let mut s = String::from("f_o_ob_ar"); s.retain(|c| c != '_'); assert_eq!(s, "foobar");
pub fn insert(&mut self, idx: usize, ch: char)
1.0.0[src]
pub fn insert(&mut self, idx: usize, ch: char)
Inserts a character into this String
at a byte position.
This is an O(n)
operation as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than the String
's length, or if it does not
lie on a char
boundary.
Examples
Basic usage:
let mut s = String::with_capacity(3); s.insert(0, 'f'); s.insert(1, 'o'); s.insert(2, 'o'); assert_eq!("foo", s);
pub fn insert_str(&mut self, idx: usize, string: &str)
1.16.0[src]
pub fn insert_str(&mut self, idx: usize, string: &str)
Inserts a string slice into this String
at a byte position.
This is an O(n)
operation as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than the String
's length, or if it does not
lie on a char
boundary.
Examples
Basic usage:
let mut s = String::from("bar"); s.insert_str(0, "foo"); assert_eq!("foobar", s);
pub unsafe fn as_mut_vec(&mut self) -> &mut Vec<u8>
1.0.0[src]
pub unsafe fn as_mut_vec(&mut self) -> &mut Vec<u8>
Returns a mutable reference to the contents of this String
.
Safety
This function is unsafe because it does not check that the bytes passed
to it are valid UTF-8. If this constraint is violated, it may cause
memory unsafety issues with future users of the String
, as the rest of
the standard library assumes that String
s are valid UTF-8.
Examples
Basic usage:
let mut s = String::from("hello"); unsafe { let vec = s.as_mut_vec(); assert_eq!(&[104, 101, 108, 108, 111][..], &vec[..]); vec.reverse(); } assert_eq!(s, "olleh");
pub fn len(&self) -> usize
1.0.0[src]
pub fn len(&self) -> usize
Returns the length of this String
, in bytes.
Examples
Basic usage:
let a = String::from("foo"); assert_eq!(a.len(), 3);
pub fn is_empty(&self) -> bool
1.0.0[src]
pub fn is_empty(&self) -> bool
Returns true
if this String
has a length of zero.
Returns false
otherwise.
Examples
Basic usage:
let mut v = String::new(); assert!(v.is_empty()); v.push('a'); assert!(!v.is_empty());
pub fn split_off(&mut self, at: usize) -> String
1.16.0[src]
pub fn split_off(&mut self, at: usize) -> String
Splits the string into two at the given index.
Returns a newly allocated String
. self
contains bytes [0, at)
, and
the returned String
contains bytes [at, len)
. at
must be on the
boundary of a UTF-8 code point.
Note that the capacity of self
does not change.
Panics
Panics if at
is not on a UTF-8
code point boundary, or if it is beyond the last
code point of the string.
Examples
let mut hello = String::from("Hello, World!"); let world = hello.split_off(7); assert_eq!(hello, "Hello, "); assert_eq!(world, "World!");
pub fn clear(&mut self)
1.0.0[src]
pub fn clear(&mut self)
Truncates this String
, removing all contents.
While this means the String
will have a length of zero, it does not
touch its capacity.
Examples
Basic usage:
let mut s = String::from("foo"); s.clear(); assert!(s.is_empty()); assert_eq!(0, s.len()); assert_eq!(3, s.capacity());
ⓘImportant traits for Drain<'a>pub fn drain<R>(&mut self, range: R) -> Drain where
R: RangeBounds<usize>,
1.6.0[src]
pub fn drain<R>(&mut self, range: R) -> Drain where
R: RangeBounds<usize>,
Creates a draining iterator that removes the specified range in the string and yields the removed chars.
Note: The element range is removed even if the iterator is not consumed until the end.
Panics
Panics if the starting point or end point do not lie on a char
boundary, or if they're out of bounds.
Examples
Basic usage:
let mut s = String::from("α is alpha, β is beta"); let beta_offset = s.find('β').unwrap_or(s.len()); // Remove the range up until the β from the string let t: String = s.drain(..beta_offset).collect(); assert_eq!(t, "α is alpha, "); assert_eq!(s, "β is beta"); // A full range clears the string s.drain(..); assert_eq!(s, "");
pub fn replace_range<R>(&mut self, range: R, replace_with: &str) where
R: RangeBounds<usize>,
1.27.0[src]
pub fn replace_range<R>(&mut self, range: R, replace_with: &str) where
R: RangeBounds<usize>,
Removes the specified range in the string, and replaces it with the given string. The given string doesn't need to be the same length as the range.
Panics
Panics if the starting point or end point do not lie on a char
boundary, or if they're out of bounds.
Examples
Basic usage:
let mut s = String::from("α is alpha, β is beta"); let beta_offset = s.find('β').unwrap_or(s.len()); // Replace the range up until the β from the string s.replace_range(..beta_offset, "Α is capital alpha; "); assert_eq!(s, "Α is capital alpha; β is beta");
Trait Implementations
impl Clone for Referer
[src]
impl Clone for Referer
fn clone(&self) -> Referer
[src]
fn clone(&self) -> Referer
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for Referer
[src]
impl Debug for Referer
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for Referer
[src]
impl PartialEq for Referer
fn eq(&self, other: &Referer) -> bool
[src]
fn eq(&self, other: &Referer) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Referer) -> bool
[src]
fn ne(&self, other: &Referer) -> bool
This method tests for !=
.
impl Deref for Referer
[src]
impl Deref for Referer
type Target = String
The resulting type after dereferencing.
fn deref(&self) -> &String
[src]
fn deref(&self) -> &String
Dereferences the value.
impl DerefMut for Referer
[src]
impl DerefMut for Referer
impl Header for Referer
[src]
impl Header for Referer
fn header_name() -> &'static str
[src]
fn header_name() -> &'static str
Returns the name of the header field this belongs to. Read more
fn parse_header(raw: &[Vec<u8>]) -> Result<Self>
[src]
fn parse_header(raw: &[Vec<u8>]) -> Result<Self>
Parse a header from a raw stream of bytes. Read more
impl HeaderFormat for Referer
[src]
impl HeaderFormat for Referer
fn fmt_header(&self, f: &mut Formatter) -> Result
[src]
fn fmt_header(&self, f: &mut Formatter) -> Result
Format a header to be output into a TcpStream. Read more
impl Display for Referer
[src]
impl Display for Referer