user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc review, as requested :-).

Browse source 
Mostly just phrasing things differently, which is a matter of taste. Feel free to use or not use any of the changes I'm suggesting.

I would say this one thing should be changed, though, not necessarily the way I changed it here.

     * Convert any string (literal, `@`, `&`, `~`)
     * that contains a base64 encoded value, to the byte values it encodes.

If this structure is going to be used, either the entire clause, 'that contains a base64 encoded value', should be bracketed by commas, or the comma at the end of the clause should be removed.
This commit is contained in:
Dan Luu 2013-04-13 16:17:30 -04:00
parent 8e64b61df9
commit 78bc10d94b
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/libstd/base64.rs
View file

@ -28,7 +28,7 @@ static CHARS: [char, ..64] = [
impl<'self> ToBase64 for &'self [u8] {
/**
* Turn a vector of `u8` bytes into a string representing them in base64.
* Turn a vector of `u8` bytes into a base64 string.
*
* *Example*:
*
@ -92,7 +92,7 @@ impl<'self> ToBase64 for &'self [u8] {
impl<'self> ToBase64 for &'self str {
/**
* Convert any string (literal, `@`, `&`, `~`) to base64 encoding.
* Convert any string (literal, `@`, `&`, or `~`) to base64 encoding.
*
*
* *Example*:
@ -119,8 +119,8 @@ pub trait FromBase64 {
impl FromBase64 for ~[u8] {
/**
* Turn a vector of `u8`s representing characters
* encoding byte values in base64 into the vector of `u8` byte values.
* Convert base64 `u8` vector into u8 byte values.
* Every 4 encoded characters is converted into 3 octets, modulo padding.
*
* *Example*:
*
@ -200,16 +200,15 @@ impl FromBase64 for ~[u8] {
impl FromBase64 for ~str {
/**
* Convert any string (literal, `@`, `&`, `~`)
* that contains a base64 encoded value, to the byte values it encodes.
* Convert any base64 encoded string (literal, `@`, `&`, or `~`)
* to the byte values it encodes.
*
* You can use the `from_bytes` function in `core::str`
* to turn a `[u8]` into a string with characters corresponding to those values.
*
* *Example*:
*
* This is an example of going from a string literal to the base64 encoding
* and back to the same string.
* This converts a string literal to base64 and back.
*
* ~~~~
* extern mod std;