Skip to content

Commit da2255b

Browse files
committed
---
yaml --- r: 95310 b: refs/heads/dist-snap c: 2076959 h: refs/heads/master v: v3
1 parent 73e35d4 commit da2255b

File tree

189 files changed

+4755
-3191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

189 files changed

+4755
-3191
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ refs/heads/try: c274a6888410ce3e357e014568b43310ed787d36
66
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
77
refs/heads/ndm: f3868061cd7988080c30d6d5bf352a5a5fe2460b
88
refs/heads/try2: 147ecfdd8221e4a4d4e090486829a06da1e0ca3c
9-
refs/heads/dist-snap: a69e4a55eb3f0b0daa4bb2fde93ee25d98b499f2
9+
refs/heads/dist-snap: 2076959336a1751bccfb24e1b8e0107341bec58a
1010
refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596
1111
refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503
1212
refs/heads/try3: 9387340aab40a73e8424c48fd42f0c521a4875c0

branches/dist-snap/Makefile.in

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,17 @@ CFG_VERSION = $(CFG_RELEASE)
147147
# numbers and dots here
148148
CFG_VERSION_WIN = 0.9
149149

150-
ifneq ($(wildcard $(CFG_GIT)),)
151-
ifneq ($(wildcard $(CFG_GIT_DIR)),)
152-
CFG_VERSION += $(shell git --git-dir=$(CFG_GIT_DIR) log -1 \
150+
# since $(CFG_GIT) may contain spaces (especially on Windows),
151+
# we need to escape them. (" " to r"\ ")
152+
# Note that $(subst ...) ignores space after `subst`,
153+
# so we use a hack: define $(SPACE) which contains space character.
154+
SPACE :=
155+
SPACE +=
156+
ifneq ($(wildcard $(subst $(SPACE),\$(SPACE),$(CFG_GIT))),)
157+
ifneq ($(wildcard $(subst $(SPACE),\$(SPACE),$(CFG_GIT_DIR))),)
158+
CFG_VERSION += $(shell git --git-dir='$(CFG_GIT_DIR)' log -1 \
153159
--pretty=format:'(%h %ci)')
154-
CFG_VER_HASH = $(shell git --git-dir=$(CFG_GIT_DIR) rev-parse HEAD)
160+
CFG_VER_HASH = $(shell git --git-dir='$(CFG_GIT_DIR)' rev-parse HEAD)
155161
endif
156162
endif
157163

branches/dist-snap/configure

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -680,11 +680,15 @@ do
680680
for s in 0 1 2 3
681681
do
682682
make_dir $t/rt/stage$s
683+
make_dir $t/rt/libuv
684+
make_dir $t/rt/libuv/src/ares
685+
make_dir $t/rt/libuv/src/eio
686+
make_dir $t/rt/libuv/src/ev
687+
make_dir $t/rt/jemalloc
683688
for i in \
684689
isaac linenoise sync test \
685690
arch/i386 arch/x86_64 arch/arm arch/mips \
686-
libuv libuv/src/ares libuv/src/eio libuv/src/ev \
687-
jemalloc sundown/src sundown/html
691+
sundown/src sundown/html
688692
do
689693
make_dir $t/rt/stage$s/$i
690694
done

branches/dist-snap/doc/rust.md

Lines changed: 197 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -239,13 +239,14 @@ literal : string_lit | char_lit | num_lit ;
239239

240240
~~~~~~~~ {.ebnf .gram}
241241
char_lit : '\x27' char_body '\x27' ;
242-
string_lit : '"' string_body * '"' ;
242+
string_lit : '"' string_body * '"' | 'r' raw_string ;
243243
244244
char_body : non_single_quote
245245
| '\x5c' [ '\x27' | common_escape ] ;
246246
247247
string_body : non_double_quote
248248
| '\x5c' [ '\x22' | common_escape ] ;
249+
raw_string : '"' raw_string_body '"' | '#' raw_string '#' ;
249250
250251
common_escape : '\x5c'
251252
| 'n' | 'r' | 't' | '0'
@@ -267,9 +268,10 @@ which must be _escaped_ by a preceding U+005C character (`\`).
267268

268269
A _string literal_ is a sequence of any Unicode characters enclosed within
269270
two `U+0022` (double-quote) characters, with the exception of `U+0022`
270-
itself, which must be _escaped_ by a preceding `U+005C` character (`\`).
271+
itself, which must be _escaped_ by a preceding `U+005C` character (`\`),
272+
or a _raw string literal_.
271273

272-
Some additional _escapes_ are available in either character or string
274+
Some additional _escapes_ are available in either character or non-raw string
273275
literals. An escape starts with a `U+005C` (`\`) and continues with one of
274276
the following forms:
275277

@@ -285,9 +287,35 @@ the following forms:
285287
* A _whitespace escape_ is one of the characters `U+006E` (`n`), `U+0072`
286288
(`r`), or `U+0074` (`t`), denoting the unicode values `U+000A` (LF),
287289
`U+000D` (CR) or `U+0009` (HT) respectively.
288-
* The _backslash escape_ is the character U+005C (`\`) which must be
290+
* The _backslash escape_ is the character `U+005C` (`\`) which must be
289291
escaped in order to denote *itself*.
290292

293+
Raw string literals do not process any escapes. They start with the character
294+
`U+0072` (`r`), followed zero or more of the character `U+0023` (`#`) and a
295+
`U+0022` (double-quote) character. The _raw string body_ is not defined in the
296+
EBNF grammar above: it can contain any sequence of Unicode characters and is
297+
terminated only by another `U+0022` (double-quote) character, followed by the
298+
same number of `U+0023` (`#`) characters that preceeded the opening `U+0022`
299+
(double-quote) character.
300+
301+
All Unicode characters contained in the raw string body represent themselves,
302+
the characters `U+0022` (double-quote) (except when followed by at least as
303+
many `U+0023` (`#`) characters as were used to start the raw string literal) or
304+
`U+005C` (`\`) do not have any special meaning.
305+
306+
Examples for string literals:
307+
308+
~~~
309+
"foo"; r"foo"; // foo
310+
"\"foo\""; r#""foo""#; // "foo"
311+
312+
"foo #\"# bar";
313+
r##"foo #"# bar"##; // foo #"# bar
314+
315+
"\x52"; "R"; r"R"; // R
316+
"\\x52"; r"\x52"; // \x52
317+
~~~
318+
291319
#### Number literals
292320

293321
~~~~~~~~ {.ebnf .gram}
@@ -1501,6 +1529,171 @@ is `extern "abi" fn(A1, ..., An) -> R`,
15011529
where `A1...An` are the declared types of its arguments
15021530
and `R` is the decalred return type.
15031531

1532+
## Visibility and Privacy
1533+
1534+
These two terms are often used interchangeably, and what they are attempting to
1535+
convey is the answer to the question "Can this item be used at this location?"
1536+
1537+
Rust's name resolution operates on a global hierarchy of namespaces. Each level
1538+
in the hierarchy can be thought of as some item. The items are one of those
1539+
mentioned above, but also include external crates. Declaring or defining a new
1540+
module can be thought of as inserting a new tree into the hierarchy at the
1541+
location of the definition.
1542+
1543+
To control whether interfaces can be used across modules, Rust checks each use
1544+
of an item to see whether it should be allowed or not. This is where privacy
1545+
warnings are generated, or otherwise "you used a private item of another module
1546+
and weren't allowed to."
1547+
1548+
By default, everything in rust is *private*, with two exceptions. The first
1549+
exception is that struct fields are public by default (but the struct itself is
1550+
still private by default), and the remaining exception is that enum variants in
1551+
a `pub` enum are the default visibility of the enum container itself.. You are
1552+
allowed to alter this default visibility with the `pub` keyword (or `priv`
1553+
keyword for struct fields and enum variants). When an item is declared as `pub`,
1554+
it can be thought of as being accessible to the outside world. For example:
1555+
1556+
~~~
1557+
// Declare a private struct
1558+
struct Foo;
1559+
1560+
// Declare a public struct with a private field
1561+
pub struct Bar {
1562+
priv field: int
1563+
}
1564+
1565+
// Declare a public enum with public and private variants
1566+
pub enum State {
1567+
PubliclyAccessibleState,
1568+
priv PrivatelyAccessibleState
1569+
}
1570+
~~~
1571+
1572+
With the notion of an item being either public or private, Rust allows item
1573+
accesses in two cases:
1574+
1575+
1. If an item is public, then it can be used externally through any of its
1576+
public ancestors.
1577+
2. If an item is private, it may be accessed by the current module and its
1578+
descendants.
1579+
1580+
These two cases are surprisingly powerful for creating module hierarchies
1581+
exposing public APIs while hiding internal implementation details. To help
1582+
explain, here's a few use cases and what they would entail.
1583+
1584+
* A library developer needs to expose functionality to crates which link against
1585+
their library. As a consequence of the first case, this means that anything
1586+
which is usable externally must be `pub` from the root down to the destination
1587+
item. Any private item in the chain will disallow external accesses.
1588+
1589+
* A crate needs a global available "helper module" to itself, but it doesn't
1590+
want to expose the helper module as a public API. To accomplish this, the root
1591+
of the crate's hierarchy would have a private module which then internally has
1592+
a "public api". Because the entire crate is an ancestor of the root, then the
1593+
entire local crate can access this private module through the second case.
1594+
1595+
* When writing unit tests for a module, it's often a common idiom to have an
1596+
immediate child of the module to-be-tested named `mod test`. This module could
1597+
access any items of the parent module through the second case, meaning that
1598+
internal implementation details could also be seamlessly tested from the child
1599+
module.
1600+
1601+
In the second case, it mentions that a private item "can be accessed" by the
1602+
current module and its descendants, but the exact meaning of accessing an item
1603+
depends on what the item is. Accessing a module, for example, would mean looking
1604+
inside of it (to import more items). On the other hand, accessing a function
1605+
would mean that it is invoked.
1606+
1607+
Here's an example of a program which exemplifies the three cases outlined above.
1608+
1609+
~~~
1610+
// This module is private, meaning that no external crate can access this
1611+
// module. Because it is private at the root of this current crate, however, any
1612+
// module in the crate may access any publicly visible item in this module.
1613+
mod crate_helper_module {
1614+
1615+
// This function can be used by anything in the current crate
1616+
pub fn crate_helper() {}
1617+
1618+
// This function *cannot* be used by anything else in the crate. It is not
1619+
// publicly visible outside of the `crate_helper_module`, so only this
1620+
// current module and its descendants may access it.
1621+
fn implementation_detail() {}
1622+
}
1623+
1624+
// This function is "public to the root" meaning that it's available to external
1625+
// crates linking against this one.
1626+
pub fn public_api() {}
1627+
1628+
// Similarly to 'public_api', this module is public so external crates may look
1629+
// inside of it.
1630+
pub mod submodule {
1631+
use crate_helper_module;
1632+
1633+
pub fn my_method() {
1634+
// Any item in the local crate may invoke the helper module's public
1635+
// interface through a combination of the two rules above.
1636+
crate_helper_module::crate_helper();
1637+
}
1638+
1639+
// This function is hidden to any module which is not a descendant of
1640+
// `submodule`
1641+
fn my_implementation() {}
1642+
1643+
#[cfg(test)]
1644+
mod test {
1645+
1646+
#[test]
1647+
fn test_my_implementation() {
1648+
// Because this module is a descendant of `submodule`, it's allowed
1649+
// to access private items inside of `submodule` without a privacy
1650+
// violation.
1651+
super::my_implementation();
1652+
}
1653+
}
1654+
}
1655+
1656+
# fn main() {}
1657+
~~~
1658+
1659+
For a rust program to pass the privacy checking pass, all paths must be valid
1660+
accesses given the two rules above. This includes all use statements,
1661+
expressions, types, etc.
1662+
1663+
### Re-exporting and Visibility
1664+
1665+
Rust allows publicly re-exporting items through a `pub use` directive. Because
1666+
this is a public directive, this allows the item to be used in the current
1667+
module through the rules above. It essentially allows public access into the
1668+
re-exported item. For example, this program is valid:
1669+
1670+
~~~
1671+
pub use api = self::implementation;
1672+
1673+
mod implementation {
1674+
pub fn f() {}
1675+
}
1676+
1677+
# fn main() {}
1678+
~~~
1679+
1680+
This means that any external crate referencing `implementation::f` would receive
1681+
a privacy violation, while the path `api::f` would be allowed.
1682+
1683+
When re-exporting a private item, it can be thought of as allowing the "privacy
1684+
chain" being short-circuited through the reexport instead of passing through the
1685+
namespace hierarchy as it normally would.
1686+
1687+
### Glob imports and Visibility
1688+
1689+
Currently glob imports are considered an "experimental" language feature. For
1690+
sanity purpose along with helping the implementation, glob imports will only
1691+
import public items from their destination, not private items.
1692+
1693+
> **Note:** This is subject to change, glob exports may be removed entirely or
1694+
> they could possibly import private items for a privacy error to later be
1695+
> issued if the item is used.
1696+
15041697
## Attributes
15051698

15061699
~~~~~~~~{.ebnf .gram}

branches/dist-snap/doc/tutorial.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,12 @@ whose literals are written between single quotes, as in `'x'`.
353353
Just like C, Rust understands a number of character escapes, using the backslash
354354
character, such as `\n`, `\r`, and `\t`. String literals,
355355
written between double quotes, allow the same escape sequences.
356-
More on strings [later](#vectors-and-strings).
356+
357+
On the other hand, raw string literals do not process any escape sequences.
358+
They are written as `r##"blah"##`, with a matching number of zero or more `#`
359+
before the opening and after the closing quote, and can contain any sequence of
360+
characters except their closing delimiter. More on strings
361+
[later](#vectors-and-strings).
357362

358363
The nil type, written `()`, has a single value, also written `()`.
359364

@@ -2322,19 +2327,18 @@ fn main() {
23222327

23232328
The `::farm::chicken` construct is what we call a 'path'.
23242329

2325-
Because it's starting with a `::`, it's also a 'global path',
2326-
which qualifies an item by its full path in the module hierarchy
2327-
relative to the crate root.
2330+
Because it's starting with a `::`, it's also a 'global path', which qualifies
2331+
an item by its full path in the module hierarchy relative to the crate root.
23282332

2329-
If the path were to start with a regular identifier, like `farm::chicken`, it would be
2330-
a 'local path' instead. We'll get to them later.
2333+
If the path were to start with a regular identifier, like `farm::chicken`, it
2334+
would be a 'local path' instead. We'll get to them later.
23312335

2332-
Now, if you actually tried to compile this code example, you'll notice
2333-
that you get a `unresolved name: 'farm::chicken'` error. That's because per default,
2334-
items (`fn`, `struct`, `static`, `mod`, ...) are only visible inside the module
2335-
they are defined in.
2336+
Now, if you actually tried to compile this code example, you'll notice that you
2337+
get a `function 'chicken' is private` error. That's because by default, items
2338+
(`fn`, `struct`, `static`, `mod`, ...) are private.
23362339

2337-
To make them visible outside their containing modules, you need to mark them _public_ with `pub`:
2340+
To make them visible outside their containing modules, you need to mark them
2341+
_public_ with `pub`:
23382342

23392343
~~~~
23402344
mod farm {
@@ -2356,7 +2360,8 @@ Rust doesn't support encapsulation: both struct fields and methods can
23562360
be private. But this encapsulation is at the module level, not the
23572361
struct level.
23582362

2359-
For convenience, fields are _public_ by default, and can be made _private_ with the `priv` keyword:
2363+
For convenience, fields are _public_ by default, and can be made _private_ with
2364+
the `priv` keyword:
23602365

23612366
~~~
23622367
mod farm {
@@ -2393,7 +2398,8 @@ fn main() {
23932398
# fn make_me_a_chicken() -> farm::Chicken { 0 }
23942399
~~~
23952400

2396-
> ***Note:*** Visibility rules are currently buggy and not fully defined, you might have to add or remove `pub` along a path until it works.
2401+
Exact details and specifications about visibility rules can be found in the Rust
2402+
manual.
23972403

23982404
## Files and modules
23992405

0 commit comments

Comments
 (0)