-
Notifications
You must be signed in to change notification settings - Fork 0
Doc detailed release notes
This page covers releases in more detail than the bullet-point list given in the RELEASES.txt file in the source distribution, in particular focusing on language level changes that will be immediately visible and/or disruptive to users trying to keep their Rust code compiling and working right between releases. It is intended to hold copied, cleaned-up versions of entries from the development roadmap as they are completed, to help users plan migration on their own code.
As part of the final sequence of major language changes, Rust is being overhauled to have fewer baked-in pointer types, and be more extensible to custom pointer types (smart pointers). In this release what have previously been termed 'managed boxes' or 'managed pointers' - the pointer type preceded with the @
sigil - have been deprecated and placed behind a feature gate. Although you may regain access to these types by applying the #[feature(managed_boxes)];
attribute to a crate, managed boxes will be completely removed very soon, so all code should begin transitioning to the Rc
or Gc
types now included in the standard library.
Rc
is a reference counted pointer located in std::rc
, and Gc
is intended to be a garbage collected pointer, located in std::gc
. Gc
is currently just a wrapper around @
, which is reference counted.
Here's an example of using Rc
and Gc
.
use std::rc::Rc;
use std::gc::Gc;
fn main() {
let rc1 = Rc::new(1);
let rc2 = rc1.clone();
println!("{}", *rc1.borrow() + *rc2.borrow());
let gc1 = Gc::new(1);
let gc2 = gc1.clone();
println!("{}", *gc1.borrow() + *gc2.borrow());
}
Note that to get the value inside one of these boxes you first call the borrow()
method, which returns &T
, then dereference that. This is indeed verbose, but in the future Rust will provide an overloadable dereference operator to make these operations easier.
In addition to the deprecation of @
, @mut
has been completely removed from the language. The new Cell
and RefCell
types in std::cell
can be used to introduce interior mutability to any types; Gc<RefCell<T>>
is the equivalent of @mut T
. The difference between Cell
and RefCell
is that RefCell
features dynamic borrowing, by which the interior can be borrowed with the borrow
method, and additional borrows are prevented dynamically at runtime. The Cell
type in contrast only allows access through a copying getter and mutation through a setter; it has no dynamic borrowing, but is limited to POD types (plain old data). In practice, we've found that dynamic borrowing is a common source of errors when dealing with mutable types with complex lifecycles, so it's probably preferable to use Cell
over RefCell
when possible.
let x = Cell::new(10);
assert_eq!(x.get(), 10);
x.set(20);
assert_eq!(x.get(), 20);
let y = Cell::new((30, 40));
assert_eq!(y.get(), (30, 40));
let x = RefCell::new(0);
x.with_mut(|x| *x += 1);
let b = x.borrow();
assert_eq!(1, *b.get());
This change again makes dealing with non-owned boxes more verbose. The next few releases will involve a lot of continued work overhauling how pointers work in Rust, so expect to see improvements to usability in the near future.
Closures have changed extensively, on the surface. ~fn
, &fn
, and @fn
have all been removed. &'a fn()
is now written 'a ||
. That is, closure types now look like their declaration. Another example, &fn(int, int) -> uint
is now |int, int| -> uint
. Additionally, plain functions (those without an environment) can now be written as fn()
rather than extern fn()
. fn(int, int) -> uint
is now a valid type.
Another function type, proc()
has been added. This represents functions which can only be called once, and are similar to ~once fn
. Their environment is stored on the heap. One can move into a proc
. They are primarily used for task bodies. do
now works exclusively with proc
s. Example: proc(int, int) -> uint
. A longer example:
use std::io::File;
use std::io::buffered::BufferedReader;
fn main() {
let f = BufferedReader::new(File::open(&Path::new("rust_is_awesome.txt")).unwrap());
do std::task::spawn() {
let mut f = f; // this is a move!;
let l = f.read_line();
println!("{}", l);
}
}
Uses of the other closure types (~fn
, @fn
) should instead use trait objects.
todo: future unboxedness
This release brought many changes to how rust libraries and native libraries link together. The compiler now supports a much larger set of functionality when dealing with static and dynamic linkage with both rust and native libraries.
The #[link]
attribute at the crate level has been deprecated in favor of the #[crate_id]
attribute. Crates should now name themselves like:
#[crate_id = "foo#0.9"];
This indicates that the crate is named foo
with a version number of 0.9
. Some other examples of crate attributes are:
crate_id |
path | name | version |
---|---|---|---|
foo |
foo | foo | 0.0 |
foo#1.0 |
foo | foo | 1.0 |
github.com/foo/bar;foo#1.0 |
github.com/foo/bar | foo | 1.0 |
Before 0.9, generating a rust library meant that a dynamic library was always generated, and all rust crates were linked to one another dynamically. As of 0.9, the compiler can now generate static rust libraries so that there will be no dynamic rust dependencies. Detailed documentation can be found in the rust manual.
There are now more flavors of rust crates which can be generated, summarized here:
-
bin
- an executable -
dylib
- a dynamic rust library -
rlib
- a static rust library. Anrlib
is Rust's version of alibfoo.a
file, and is used to statically link libraries together. -
staticlib
- a static archive used to integrate rust into an existing application
Each of these flavors can be passed to the compiler via flags (--bin
, --rlib
, etc), and they may also be an attribute inside the crate (#[crate_type = "staticlib"]
). The compiler can generate multiple outputs simultaneously if more than one format is specified.
Native libraries are now supported as first-class citizens in rust. Usage of the link_args
attribute to link native libraries is deprecated and now behind a feature gate (feature(link_args)
). Native libraries are now linked with a #[link]
attribute (different than the deprecated crate version) on extern
blocks. Examples are shown below:
// Dynamically link to a native library called "foo"
#[link(name = "foo")]
extern {
fn foo_function();
}
// Statically link to a native library called "bar"
#[link(name = "bar", kind = "static")]
extern {
fn bar_function();
}
// Dynamically link to an OSX framework called "baz"
#[link(name = "baz", kind = "framework")]
extern {
fn baz_function();
}
With the advent of linking to static native libraries, it is now possible to have a native library that is purely a build dependency and need not be distributed alongside the rust library.
The rust runtime has received yet another round of lots of love for the 0.9 release. You'll find that lots of things have been moved around, but all functionality should still exist in one form or another. Major components of the 0.9 release was a complete I/O overhaul and a complete std::comm
(channels) overhaul.
All I/O now lives in the top-level std::io
module with sub-functionality underneath it. This is mostly a movement of the old std::rt::io
to std::io
, but some interfaces have been improved and tweaked along the way.
Most of the "filesystem functionality" in 0.8 was spread out across std::os, std::rt::io, std::path and friends. This has now all been consolidated into std::io::fs. For green threads, none of this continues to use a blocking implementation (it's all an appropriate libuv implementation).
In addition to an I/O update, the std::comm
interface has been completely overhauled and redone. You'll find that all the old traits are gone, oneshots are gone, and SharedChan
is no longer constructed from Chan
. The new channels are much faster than their older counterparts, and the constructors are now done through the types rather than top-level functions.
let (p, c) = Chan::new();
c.send(());
p.recv();
let (p, c) = SharedChan::new();
let c2 = c.clone();
c2.send(());
p.recv();
You'll also find that the std::comm::select
module supports selection over channels, but the interface is not fully baked yet. You can see an example usage of the macro defined in that module for using select!
, but it is not currently available to all programs.
A major improvement of channels from before is that they now work seamlessly in and out green and native modes. You must have a local rust Task to receive on a channel (that's how it knows to block), but you can send on a channel from essentially any context.
All I/O implementations have been refactored into two separate libraries, libgreen and libnative. The green-threading library (libgreen) is a libuv-backed implementation of all I/O (just refactored outside of libstd). The native-threading library (libnative) is a pthread/libc-backed implementation of all I/O (much of it new code).
You can explicitly link to one or the other in order to use I/O handles, but this is not recommended. If a library or application is compiled against libstd, then it will work seamlessly among native and green threads with no modifications.
Details on how to use libgreen and libnative can be found in a mailing list post, and more extensive documentation will be available for the next release (a few portions are still in flux).
For now, libgreen is still used as the default for booting programs, but it is planned that for the 1.0 release of Rust to use libnative by default.
Users of the old start_on_main_thread
function should now use code similar to this:
extern mod native;
#[start]
fn start(argc: int, argv: **u8) -> int {
do native::start(argc, argv) {
main();
}
}
fn main() {
// This function is running on the main native thread
}
Keep in mind that not all I/O is implemented for native threads at this time. Missing components are timers, signals, unix sockets, and DNS.
Note that this code will probably look different in the future (opting into a main-thread libnative startup).
The closure-based for
loop syntax has been replaced with one based on iterator objects. Iterator objects were already widely in use by Rust 0.7, so for most code the only difference will be the lack of a call to the advance
compatibility method.
Rust 0.7:
let mut xs = [1, 2, 3];
let ys = [4, 5, 6];
for xs.mut_iter().zip(ys.iter()).advance |(x, y)| {
*x = *y + 5;
}
Rust 0.8:
let mut xs = [1, 2, 3];
let ys = [4, 5, 6];
for (x, y) in xs.mut_iter().zip(ys.iter()) {
*x = *y + 5;
}
If there is still a function using the old iterator protocol, you can manually pass a closure or use a do
loop, as a stopgap until it is rewritten as an iterator:
do old_iteration_function() |_x| {
true
};
For more information, see the iterator tutorial.
format!
is a new macro for formatting strings, to eventually replace fmt!
. The main reasons for this change were:
-
format!
is much higher performance thanfmt!
, namely 0 allocations are performed -
format!
has less code bloat at callsites (and generally on object size) -
format!
uses traits to format arguments, meaning that formatting is extensible to all types -
format!
was designed with future i18n efforts in mind, leading to the newer syntax. -
format!
supports formatting into genericrt::io::Writer
streams instead of only to strings
Some examples of the new formatting syntax are:
format!("Hello") // => ~"Hello"
format!("Hello, {:s}!", "world") // => ~"Hello, world!"
format!("The number is {:d}", 1) // => ~"The number is 1"
format!("{:?}", ~[3, 4]) // => ~"~[3, 4]"
format!("{value}", value=4) // => ~"4"
format!("{} {}", 1, 2) // => ~"1 2"
This change also means that other macros based on fmt!
will be migrating to format!
syntax soon. None of the macros were removed from 0.8, but they will likely be removed in the next release. In the meantime, new macros were introduced using the format!
syntax by appending a 2
at the end of the name (debug2!()
, fail2!()
, info2!()
, etc.). The assert!
macro does not have a format!
equivalent, it still used the old fmt!
syntax.
Additionally, a new macro, format_args!
was added. This can be used to support format!
-style logging/printing without requiring an allocation to be performed. The idea of this macro is to create a va_args
-like struct which is opaque to the user but validated at compile-time. This is then passed around and can eventually be handed back to std::fmt
to print/create a string. usage of this macro can be found in the documentation.
Extensive documentation about this syntax extension can be found in the module's header.
The FFI was changed to be more efficient, introducing first-class foreign function pointers. All calls to foreign functions now happen directly, whereas previously they were called through a wrapper function that switched to a special C stack before the call. In order to ensure that there is enough stack space available to run foreign code, any function that calls a foreign function must be annotated with the #[fixed_stack_segment]
attribute. This attribute ensures that the function executes with a large amount of stack available.
extern {
fn a_foreign_fn();
}
#[fixed_stack_segment]
fn a_caller_of_a_foreign_fn() {
a_foreign_fn();
}
Strategic placement of the fixed_stack_segment
attribute can make FFI calls very efficient at the expense of extra annotations. When performance is not a concern, the externfn!
macro can be used to declare the foreign function and the fixed-segment wrapper at once.
externfn!(fn a_foreign_fn());
Because they are now called directly, C foreign functions now have the type extern "C" fn
and can be passed by value and called from Rust code:
let f: extern "C" fn() = a_foreign_fn;
f();
Functions for converting between types have been renamed (or added) to follow a new convention:
-
as
: cheap conversions that are normally just converting a reference to a different type, but not changing the in-memory representation, e.g.string.as_bytes()
gives a&[u8]
view into a&str
. These don't consume the convertee. -
to
: expensive conversions that may allocate and copy data, e.g.string.to_owned()
copies a&str
to a new~str
. These also don't consume the convertee. -
into
: conversions that consume the convertee and almost always don't allocate new memory (they may change the in-memory representation, but will normally do so in-place), these are cheaper thanto
conversions, e.g.string.into_bytes()
converts a~str
to a~[u8]
without copying.
These are not hard rules, since generically implemented functions mean that an into
conversion that doesn't copy/allocate is impossible for some types, e.g. string.into_owned()
(from the Str
trait) doesn't copy when string
is ~str
, but it is forced to when string
is &str
or @str
.
The Rust runtime, which includes the task scheduler, previously written in C++, was rewritten in Rust, making Rust almost completely self-hosting. For the most part this does not have visible changes, though there are a few regressions in message passing functionality (particularly related to 'select' - receiving on multiple ports) and lurking bugs. The largest regression is the temporary removal of segmented stacks. For the time being all Rust tasks run with large stacks and no overflow protection. This means that it is possible to cause segfaults and other odd behavior by recursing deeply.
The runtime rewrite was performed in order to facilitate a new I/O subsystem that integrates an I/O event loop such that I/O does not block the task scheduler. This I/O system is temporarily located in std::rt::io
and implements TCP, UDP, files, timers, and process spawning. It is incompatible with the old, still-used std::io
, but will replace it in the future, and should be considered experimental.
Related links:
- Turning on the runtime: https://mail.mozilla.org/pipermail/rust-dev/2013-August/005158.html
- Scheduler rewrite issue: https://github.com/mozilla/rust/issues/4419
For even more information about what happened during this release cycle, see the past editions of 'This Week in Rust'.
- http://cmr.github.io/blog/2013/07/13/this-week-in-rust/
- http://cmr.github.io/blog/2013/07/21/this-week-in-rust/
- http://cmr.github.io/blog/2013/07/29/last-week-in-rust/
- http://cmr.github.io/blog/2013/08/04/this-week-in-rust/
- http://cmr.github.io/blog/2013/08/10/this-week-in-rust/
- http://cmr.github.io/blog/2013/08/19/this-week-in-rust/
- http://cmr.github.io/blog/2013/08/25/this-week-in-rust/
- http://cmr.github.io/blog/2013/08/31/this-week-in-rust/
- http://cmr.github.io/blog/2013/09/07/this-week-in-rust/
- http://cmr.github.io/blog/2013/09/15/this-week-in-rust/
- http://cmr.github.io/blog/2013/09/23/this-week-in-rust/
This release didn't have many breaking language changes that require lengthy explanation beyond the short release notes, but there were many improvements to the libraries this time, and it feels like the standard library is beginning to reflect the final design.
The copy
keyword is being removed in favor of traits. Explicit copying is now performed with the clone
method of the Clone
trait, which can automatically be derived with #[deriving(Clone)]
. Clone
is part of the Rust prelude so is always in scope.
#[deriving(Clone)]
struct PopsicleToken;
let my_token = PopsicleToken;
let your_token = my_token.clone();
Clone
makes shallow copies of managed pointers and other shared pointer types like Rc
and ARC
. For deep copies use the DeepClone
trait and the deep_clone
method.
Note that copy
has not been removed from the language yet and there are still some types like fixed-size arrays and tuples without Clone
implementations.
Rust is in the middle of a transition to a new iterator mechanism. Instead of using higher-order functions like Ruby ("internal iterators") Rust will use Iterator
types, like Java ("external iterators"). There was an excellent blog post recently exploring the pros and cons of each. External iterators are more flexible and their code is believed to be faster to generate.
Note that the for
protocol is still using the old iteration protocol, but it will be updated in the next release. For compatibility with for
, Iterator
s have an advance
method that converts them to the old-style.
let v = [0, 1];
for v.iter().advance |i| { ... }
There is a new tutorial on this topic.
Further reading:
- https://mail.mozilla.org/pipermail/rust-dev/2013-June/004364.html
- https://mail.mozilla.org/pipermail/rust-dev/2013-June/004599.html
Rust now has a proper numerical tower, defined in std::num
. All numeric types implement trait Num
, which in turn inherits from the operator traits, Neg
, Add
, Eq
, as well as the Zero
and One
traits. Num
itself defines no methods.
pub trait Num: Eq + Zero + One
+ Neg<Self>
+ Add<Self,Self>
+ Sub<Self,Self>
+ Mul<Self,Self>
+ Div<Self,Self>
+ Rem<Self,Self> {}
Signed
types extend Num
with methods specific to signed types, such as abs
, and there's a corresponding Unsigned
trait (that defines no new methods).
The Real
trait then defines the the interface required of real numbers, which inherits from Signed
as well as a number of traits that define common math operations: Fractional
, Algebraic
, Trigonometric
, and Hyperbolic
. RealExt
further defines less common operations, the gamma and bessel functions.
Then there are a number of traits specific to primitive numeric types:
-
Bounded
types have a minimum and maximum value. -
Bitwise
inherits from the bit-twiddling operators,BitAnd
,BitOr
,BitXor
,Shl
,Shr
, as well asNot
, and further defines several methods for counting and querying bits. -
Primitive
again collects a number of traits that are implemented by the primitive types. -
Int
andFloat
traits define the interface to machine integers and floats.
Furthermore, Add
, Sub
, Mul
, and Neg
no longer include compound assignment in favor of the upcoming AddAssign
, SubAssign
, etc traits. For now, ported code shall take the form of foo = foo + bar
instead of foo += bar
.
While rustpkg is still in an experimental state, there are a number of improvements; see the rustpkg manual for more details.
- rustpkg uses a URL-like package ID to specify a local or remote package, and has the ability to download remote packages from github.
- rustpkg infers package IDs from directory structure; packages need no longer declare their identity explicitly
- Package IDs can have explicit versions attached.
- Package scripts (pkg.rs) are no longer required; rustpkg infers crates to build based on reasonable defaults.
- Package scripts can explicitly invoke the default build logic.
- rustpkg requires a specific directory structure for workspaces.
- rustpkg infers dependencies from
extern mod
directives, and doesn't require-L
flags on the command line for finding libraries.
This was a very busy development cycle focused on completing as many of the planned language-level changes as possible in the release time-window. While we cannot promise that this is the last time there will be incompatible changes, the great majority of anticipated language-level changes are complete in this version. We expect subsequent releases before a beta and final 1.0 to be more focused on non-language-level work (performance, libraries, packaging and building, runtime system) with only modest language-level changes as we discover bugs and areas requiring residual polish (primarily in the trait system, macro system, and borrow check).
- The
self
type parameter in traits was renamedSelf
(capital) to help differentiate it from the keywordself
- The implicit
self
parameter in trait methods is now deprecated. Methods should now specify theirself
parameter explicitly. - The
Durable
trait was removed; it is synonymous, as a type-bound, with thestatic
lifetime. - Trailing sigils on closure types such as
fn@
,fn~
andfn&
were removed in favour of the more-consistent leading sigils@fn
,~fn
and&fn
- The
const
keyword was renamed tostatic
, to accommodate for future unsafe mutable static variables. - The
export
keyword, formerly deprecated, was removed;pub use exported::path;
is synonymous. - The
move
keyword was removed; owned types are always passed and assigned by moving now. - The
fail
andassert
keywords were replaced with macrosfail!()
andassert!()
. - The
log
keyword was removed; usedebug!()
,error!()
and similar macros. - Single-element tuples, denoted
(T,)
were added as a special-case to help with some macros. - "Newtype" enums (those with a single variant) such as
enum Foo = int;
were removed; use tuple structs such asstruct Foo(int);
instead - The visibility modifiers (
pub
andpriv
) are no longer permitted on trait implementations. They were redundant with the visibility modifiers on trait and type declarations themselves. - The
#[deriving_eq]
attribute (and the related ones forclone
anditer_bytes
) was removed; use#[deriving(Eq)]
instead. Multiple traits can be specified in the same attribute, as in#[deriving(Eq, Clone, IterBytes)]
.
The mut
keyword is no longer permitted in ~mut T
, [mut T]
, or in fields of structures; in all cases mutability is controlled by mutability of the owner (inherited mutability). So things written like this in 0.5:
struct Foo {
mut x: int,
mut y: int
}
fn main() {
let z = Foo { x: 10, y: 11 };
z.y = 12;
}
must now be written like this in 0.6:
struct Foo {
x: int,
y: int
}
fn main() {
let mut z = Foo { x: 10, y: 11 };
z.y = 12;
}
This change permits reasoning about mutability of an owned structure by reasoning about the mutability of its owner, which in turn means many structures support "freezing" and "thawing": acquiring mutator-methods (statically) when held in a mutable owner, and losing those methods (statically) when moved to an immutable owner.
A function like this in 0.5:
fn foo<T:X Y Z, U:Q>() {
}
is written like this in 0.6:
fn foo<T:X + Y + Z, U:Q>() {
}
A trait implementation that was written this way in 0.5:
impl Ty : Trait {
}
is written this way in 0.6:
impl Trait for Ty {
}
Foreign modules (those declared extern
) have been simplified to anonymous extern
blocks, and all extern
functions are now unsafe. This means that code like this in 0.5:
extern mod libc {
fn getc() -> c_char;
}
fn main() {
let x = libc::getc();
}
must be written this way in 0.6:
extern {
fn getc() -> c_char;
}
fn main() {
unsafe {
let x = getc();
}
}
Vectors can now be matched against any combination of prefix, suffix and variable-length remainder patterns. The vector is destructured into the variable names given: the variable-length remainder is bound to a slice:
-
[a, b..]
to match a vector prefix -
[..a, b]
to match a vector suffix -
[a, ..b, c]
to match both prefix and suffix
This release completes the consolidation of older "structural records" (those lacking a constructor name, denoted directly as {field: type, ...}
) with the newer "nominal structs". Old code written like this in 0.5:
type Cat = {
name: ~str,
color: Color
};
fn main() {
let x = { name: ~"fluffy", color: Grey };
}
Must be written this way in 0.6:
struct Cat {
name: ~str,
color: Color
}
fn main() {
let x = Cat { name: ~"fluffy", color: Grey };
}
- Borrowing a mutable managed pointer (i.e. passing
@mut T
to an argument of type&T
or&mut T
) changed. The borrow is now performed with a dynamic (runtime) write-barrier check that can fail if multiple borrows are performed on the same value. In other words, the type@mut T
now behaves like the library moduleMut<T>
did in 0.5. This change means that a class of potential errors -- multiple mutable aliases of the same memory -- that was formerly prohibited by a conservative static rule in 0.5 will be left to a dynamic check at runtime in 0.6. Experience with the rule present in 0.5 and before demonstrated that the static rule was too restrictive to be useful in practice. We will monitor the resulting semantics carefully to see if the new dynamic failure mode occurs frequently in practice.
-
use
statements are now crate-relative by default, meaning that they resolve from the "top" of the crate. - As a specific corollary: "chained"
use
statements -- those that refer to abbreviated names when finding targets -- are no longer legal. For example:use std::libc; use libc::raw;
must now be writtenuse std::libc; use std::libc::raw;
. - The
super
andself
can be used in paths to refer to parent modules and the current module, respectively. -
extern mod
statements must occur beforeuse
statements, anduse
statements can now shadowextern mod
statements (rather than vice-versa, as was the case in 0.5). This change makes the shadowing behavior betweenextern mod
,use
and module-local item definitions consistent with the (required) order of writing them.
- the nil type
()
is now properly 0 bytes - the "main function" of an executable crate -- where execution begins -- does not need to be called
main
anymore. Whilemain
is the default, any function marked with the attribute#[main]
will override this behavior. - The default type of an inferred closure (such as
|x| x+1
) is now&fn
rather than@fn
as it was in 0.5.
Rust now supports using inline assembly through the asm!
macro. The syntax roughly matches that of gcc/clang:
asm!(assembly template
: output operands
: input operands
: clobbers
: options
);
asm!
must be wrapped in an unsafe
block.
Assembly Template
The assembly template
is the only required parameter and must be a literal string (i.e ""
)
asm!("NOP");
Output operands, input operands, clobbers and options are all optional but you must add the right number of :
if you skip them:
asm!("xor %eax, %eax"
:
:
: "eax"
);
Whitespace also doesn't matter:
asm!("xor %eax, %eax" ::: "eax");
Operands
Input and output operands follow the same format: : "constraints1"(expr1), "constraints2"(expr2), ..."
. Output operand expressions must be mutable lvalues:
fn add(a: int, b: int) -> int {
let mut c = 0;
unsafe {
asm!("add $2, $0"
: "=r"(c)
: "0"(a), "r"(b)
);
}
c
}
Clobbers
Some instructions modify registers which might otherwise have held different values so we use the clobbers list to indicate to the compiler not to assume any values loaded into those registers will stay valid.
// Put the value 0x200 in eax
asm!("mov $$0x200, %eax" : /* no outputs */ : /* no inputs */ : "eax");
Input and output registers need not be listed since that information is already communicated by the given constraints. Otherwise, any other registers used either implicitly or explicitly should be listed.
If the assembly changes the condition code register cc
should be specified as one of the clobbers. Similarly, if the assembly modifies memory, memory
should also be specified.
Options
The last section, options
is specific to Rust. The format is comma separated literal strings (i.e :"foo", "bar", "baz"
). It's used to specify some extra info about the inline assembly:
Current valid options are:
-
volatile - specifying this is analogous to
__asm__ __volatile__ (...)
in gcc/clang. -
alignstack - certain instructions expect the stack to be aligned a certain way (i.e SSE) and specifying this indicates to the compiler to insert its usual stack alignment code
-
intel - use intel syntax instead of the default AT&T.
This was a fairly slow development cycle that focused on implementing more trait features, such as trait inheritance and static methods, with the goal of enabling more expressive standard libraries. This version more-or-less completes Rust's long transition to a linear type system, with non-copyable types moving automatically (the move
keyword is deprecated).
Work continues on requiring that instance methods always use explicit self-type declarations, and now self
, &self
, ~self
, and @self
are all valid self types and should work. Methods with explicit self are declared like fn foo(self, arg1: Type1, arg2: Type2) { ... }
. The old method declaration syntax, without a self type, is deprecated and will likely be removed in 0.6.
struct MyType { ... }
impl MyType {
fn i_need_a_managed_box(@self) { ... }
fn i_need_an_owned_box(~self) { ... }
}
let managed_value = @MyType { ... };
managed_value.i_need_a_managed_box();
Self types also have correct support for move semantics, enabling some nice patterns for unique types.
enum Option<T> { Some(T), None }
impl<T> Option<T> {
fn unwrap(self) -> T {
// Extract the value from the option and return it.
// There is no copying here as these operations all
// move by default now for unique types.
match self {
Some(v) => v,
None => fail
}
}
}
fn maybe_get_value() -> Option<MyType> { ... }
let value = maybe_get_value().unwrap();
Traits may now declare supertraits. When a trait has supertraits then any type which implements the subtrait must also implement the supertrait. Trait inheritance allows a group of traits to be treated as a single trait in bounded type parameters.
trait Add {
fn add(&self, other: &self) -> self;
}
trait Sub {
fn sub(&self, other: &self) -> self;
}
trait Num: Add Sub { }
The methods of each trait must still be implemented seperately.
impl MyNumType: Add {
fn add(&self, other: &MyNumType) -> MyNumType { ... }
}
impl MyNumType: Sub {
fn sub(&self, other: &MyNumType) -> MyNumType { ... }
}
impl MyNumType: Num { }
Then the constrained trait may be used in type parameter constraints in place of its supertraits.
fn calculate<T: Num>(val1: T, val2: T, val3: T) -> T {
val1.add(&val2).sub(&val3)
}
Note that supertrait methods are not yet available on subtrait 'object' types.
// This doesn't work yet
let t = &MyNumType { ... };
let num = t = &Num;
num.add(othernum);
Furthermore, trait inheritance is not yet aware of the "kind" traits, so using Copy
, etc. as supertraits will not work as expected.
In 0.4 static methods 'leaked' out of the traits in which they were defined and were resolved in the outer module scope. This would mean that two sibling traits couldn't define a static method with the same name.
// Couldn't do this before because `bar` actually exists in the outer scope
trait Foo<T> { static fn bar() -> T; }
trait Baz<T> { static fn bar() -> T; }
fn quux<T>() -> T {
return bar();
}
In 0.5 the module and type namespaces are merged and static methods are resolved under the name of the trait in which they are defined.
// Now this is valid
trait Foo<T> { static fn bar() -> T; }
trait Baz<T> { static fn bar() -> T; }
fn quux<T>() -> T {
// Now trait names may be used in paths to access static methods
return Foo::bar();
}
// Likewise, static methods on types (anonymous traits) may be accessed via the type name
struct Swizzle { ... }
impl Swizzle { static fn bar() -> T; }
fn swozzle<T>() -> T {
return Swizzle::bar();
}
Path resolution has changed significantly to keep in-scope identifiers from leaking from parent modules to submodules. The old behavior, particularly when dealing with large projects with many files, made knowing what was in scope very difficult and prone to error.
In response, we're making a change to how imports (use
statements) are resolved. They are now resolved relative to the top of the crate by default, and can be thought of as absolute paths through the crate's module namespace. Paths may be prefixed with the contextual keywords self
and super
to modify how the lookup is performed.
extern mod std;
mod foo {
// Bring `net` into scope
use std::net;
fn f() { ... }
// This submodule no longer inherits the scope of the outer module
mod bar {
// Need to import `net` again to use it
use std::net;
}
mod baz {
// We can also use `super` to get at `foo`s import
use super::net;
}
mod quux {
// Can also use `self` to import from child modules
use self::boo::net;
mod boo {
pub use std::net;
}
}
}
Note: There will be related changes to path resolution in other contexts as well in the next release
Note: self
and super
will likely be promoted to full keywords (not contextual keywords) in the next release
Implementations of the Eq
and IterBytes
can be automatically derived using syntax extensions (types that implement IterBytes
can automatically implement Hash
, so can be used in hash tables).
#[deriving_eq]
#[deriving_iter_bytes]
struct Foo {
bar: int
}
This should work on all struct and enum types, and does what you would likely expect, delegating to the corresponding impls of each subcomponent in turn.
This release adds a new API for dealing with errors, core::condition
. Unlike the concept of exceptions in other languages, conditions are handled at the site where they are raised rather than the site where they are caught. Failure to handle a condition results in task failure.
// A condition has a name, input type and output type.
// The input type contains details of the condition, passed to a handler.
// The output type is what the handler will return if it handles the condition.
condition! {
missing_input_file : Path -> Reader;
}
// Install the handler
do missing_input_file::cond.trap(|pathname| {
// Handle a missing input file by providing a fake empty reader.
io::BytesReader { bytes: bytes, pos: 0u } as Reader
}).in {
// The condition handler is valid over the dynamic extent
// of the block passed to trap.
foo(&Path("/nonexistent"))
}
fn foo(p: &Path) {
let r = if p.exists() {
io::file_reader(p)
} else {
// If there's a handler in one of our callers, this
// will evaluate to the handler's return value and
// we will carry on, no unwinding.
missing_input_file::cond.raise(p)
}
let v = r.read();
// ...
}
The standard library has not yet been updated to make use of conditions.
The Send
trait, one of the built-in 'kinds', is now called Owned
. Owned
types contain no managed or borrowed pointers. The little-known trait previously called Owned
is now called Durable
. Durable
types contain no borrowed pointers (though in the future they will probably allow borrowed pointers to the static
region). All Owned
types are Durable
.
The declarative language for .rc files has been removed. The biggest practical implication of this change is that, for projects using 'companion modules',
a project.rc
combined with project.rs
, the companion module (project.rs
) will not be loaded automatically. You should copy the contents of project.rs
into project.rc
and delete project.rs
.
The move
keyword is no longer needed under normal circumstances and should be considered deprecated. Types that are not implicitly copyable now move by default.
This version was focused on completing as many disruptive syntax changes as possible, including changing and reducing keywords, beefing up traits and removing classes, changing how imports and exports are handled, and moving to a camel case convention for types.
Borrowed pointers matured and replaced argument modes in some of the libraries. A number of new concurrency features were added.
We have a new convention that requires that types (and enum variants, which are not yet types) be camel cased. The entire core and standard libraries have been converted. We generally prefer that acronyms not be written with all caps, so e.g. the standard URL type is written Url
.
There is a lint check for this called non_camel_case_types
but it is disabled by default.
This release tried to narrow down the set of keywords and the current keywords are expected to be close to final.
Keyword changes:
-
iface
becametrait
-
ret
becamereturn
-
alt
becamematch
-
again
was removed in favor of reusingloop
to continue, i.e.loop { if foo { loop; } }
-
import
andexport
were removed in favor ofpub
andpriv
item-level visibility (see below). -
class
was removed in favor of combinations ofstruct
,impl
andtrait
The current keywords are as follows.
as assert
break
const copy
do drop
else enum extern
fail false fn for
if impl
let log loop
match mod move mut
priv pub pure
ref return
self static struct
true trait type
unsafe use
while
Notes:
-
be
is not a keyword, but is reserved for possible future use. -
self
andstatic
are currently parsed as contextual keywords, but are expected to not be keywords in the future. -
assert
,log
, andfail
are likely to be converted to macros. -
drop
may become a trait rather than a keyword, as mightconst
.
Classes were overhauled; the class
syntax was removed from the language, in favor of method-less structs
combined with method-bearing impls
. The new struct
syntax is very simple:
struct Cat {
name: ~str,
tail_color: KittyColor
}
let my_cat = Cat {
name: ~"Morton",
tail_color: KittyColorBlack
};
// Methods for all types are defined in impls
impl Cat {
fn meow() { }
}
my_cat.meow();
There is no explicit constructor syntax. The current, and likely temporary, convention for constructors is to create a function with the same name as the type. In the future constructors will probably be defined with static new
methods.
// Current convention for defining constructors
fn MyStruct() -> MyStruct {
MyStruct {
field1: initial_value_of_field1(),
field2: initial_value_of_field2()
}
}
let m = MyStruct();
// Potential future convention for defining constructors
impl MyStruct {
// Here, the staticness of the function is indicated by the lack of
// an explicit self-type, another in-progress change.
fn new() -> MyStruct {
MyStruct {
field1: initial_value_of_field(),
field2: initial_value_of_field()
}
}
...
}
let n = MyStruct::new();
The last remnants of classes, destructors are temporarily implemented with drop
blocks on structs. In future releases destructors will be implementations of a Drop
trait.
// How to write a destructor today
struct MyStruct {
field1: Field1Type,
drop {
// Run destructory code here
}
}
// How to write a destructor in hypothetical future-Rust
impl MyStruct : Drop {
fn drop() {
}
}
See also pcwalton's proposal.
(#2794) Traits are interface-like units of behavior that carry method implementations and requirements on the self-type; they can be used to achieve code reuse without introducing much of the pain that comes from conventional inheritance: they can be mixed in any order, can be declared independent from the type they affect, and are compiled independently for each type that implements them (indeed, will inline and specialize exactly as any other function will).
This work involved replacing the iface
keyword with trait
and supporting full method implementations within traits, not just signatures. The terms employed by Rust's OO system are therefore now struct
, trait
and impl
. We believe this will be the final set of terms.
(pcwalton:impl-coherence) Previously each impl
had a name and when a client called a method on an impl
, the code dispatched-to was chosen based on the impl
imported into the client code's scope. This was chosen as a way to be unambiguous about selecting implementations -- a problem in any typeclass system -- but in practice it has been very confusing for users: many are unable to tell why a method can or cannot be seen due to the presence or absence of imports.
Now every type can have at most one impl
defined for each trait
, and that definition must occur either in the crate defining the type or the crate defining the trait
.
The arms of match
(previously alt
) expressions have a new syntax. Each case is now followed by a fat arrow, =>
, and the block is optional. Cases are separated by commas.
// The new syntax is quite compact for one-line cases
match foo {
bar => baz,
quux => fail
}
match foo {
bar => {
baz
} // Note: no comma needed when using braces
quux => {
fail
}
}
See also #3057.
We are in the process of generalizing traits so that they can include
both methods (which take a receiver) and functions (which do not). To
that end, we have added a syntax called explicit self. In the
explicit self system, methods are identified because their first parameter
is called self
(similar to Python). Optionally, the parameter can include a sigil
indicating what kind of pointer should be used:
struct Foo { ... }
impl Foo {
fn method0(self, ...); // self has type `Foo`
fn method1(&self, ...); // self has type `&Foo`
fn method2(&mut self, ...); // self has type `&mut Foo`
fn method3(@self, ...); // self has type `@Foo`
fn method4(~self, ...); // self has type `~Foo`
}
Explicit self can also appear in trait declarations. Explicit self is currently optional but is expected to become mandatory in a future release.
Traits can now include methods that do not make use of a receiver.
Such functions are (currently) labeled with the keyword static
.
Static functions are (currently) exported as functions in the module
which contains the trait where they were declared. Here is an
example:
trait FromInt {
static fn from_int(i: int) -> self;
}
struct Foo { v: int }
impl Foo: FromInt {
static fn from_int(i: int) -> Foo {
Foo { v: i }
}
}
fn main() {
let x: Foo = from_int(3);
io::println(fmt!("%?", x));
}
In the future, when explicit self is mandatory, static functions will
be designated by the absence of a self receiver. They are also
expected to become members of the trait itself, so you would write
FromInt::from_int()
.
(#2300) There was some tension in readability between "ease of scanning a module's exports" and "ease of reading the code and knowing which item is exported when you're looking at it." Ultimately we came down on the side of maintainability: that it's less work for a maintainer to mark the items where they occur, rather than scrolling back and forth between export-list and item definitions. Along with moving exports to the items themselves, we changed the terms to use the same keywords used for access control in structs: pub
and priv
.
(also #2082) Many Rust programmers stub their toes on the difference between import
and use
; both "read like" they should somehow make-available the elements in the target module. Since removing export
(see above) there is an asymmetry in the keywords anyways, so we removed the keyword import
, switched use
to mean what import
previously meant, and now denote crate-linkage through extern mod foo = (...)
.
(also #2082) This has to do with making the resolve pass coherent. In the old resolve code, resolving modules and resolving items glob-imported from modules was intermixed, and could lead to incoherence of the algorithm. In the new resolve code (landed in 0.3) there is a separation of passes: module-imports are not run through globs, only module-to-module renamings, and are resolved first, and then all imports through modules (including glob-imports) are resolved after. The module-import syntax is therefore separate, written as use mod foo = bar;
to reflect this algorithmic separation.
Macros are now invoked with a postfix !
instead of prefix #
, as in debug!("foo")
.
We also have a powerful new way to define macros with the macro_rules!
syntax extension. Macros are now based on trees of tokens with balanced braces instead of the full AST expressions the old macro implementation used.
See also the macro tutorial.
- Region names are specified as
&r/T
instead of&r.T
Operator overloading is now expressed through a set of traits in the core library. The traits, as well as implementations on standard types can be found in core::ops
and core::cmp
. The set of overloaded operators has not changed, merely the mechanism used to define overloads.
All hash functions in the standard library were replaced. Hashing is now statically dispatched (via traits) to an implementation of SipHash, a fast keyed hash function. All hashtables are also now randomly keyed from Rust's CPRNG (ISAAC, seeded from the operating system PRNG on startup). In practice this should help defend Rust programs against complexity attacks.
(#2030) Previous versions of Rust attempted to select optimal default argument-passing behavior (by-reference or by-value) based on type-directed heuristics, with sigils available to override the defaults. This system (called "modes" or "argument modes") was responsible for the presence of the sigils +
, -
, &
and &&
on function parameters.
In practice this system was simultaneously too confusing to use and too inflexible with respect to scenarios where first-class borrowed pointers were desired (returning by reference, storing non-escaping pointers into structured values, etc.) Therefore in 0.4, as first-class borrowed pointers (the other, more pervasive use of the syntax &T
) have matured to be a better alternative in almost all cases, and many of the residual motives for modes made redundant by full monomorphization, we have deprecated (and removed in as much code as possible) the mode system; it should not be visible to users and support for it is only available by opting in with the #[legace_modes]
crate attribute.
(nmatsakis:mut) After several repeated attempts to treat mutability as a full type constructor, we have settled on treatment as an inherited storage-qualifier. That is, while the mut
keyword can still only be used to qualify storage locations (the referents of pointers, variables, fields in structures), by placing mut
on a storage location you now implicitly deeply mut
-qualify all of the owned (sendable) types within the mutable location. This makes sense if you consider that an "outer" mut
qualification could always effectively mutate an inner "immutable" qualification by simply overwriting the entire containing location. This change therefore only makes the rule explicit in the type system; it is in other words a matter of improving the type system's soundness with respect to mutability.
struct S1 {
field: ~S2;
}
struct S2 {
intfield: int,
boxfield: @int
}
let mut s1 = S1 { field: S2 { intfield: 1, boxfield: @2 } };
// s1 is in a mutable slot so we can mutate the fields
s1.field = S2 { intfield: 3, boxfield: @4 };
// We can also reach through owned boxes and mutate their insides
s1.field.intfield = 5;
// Managed boxes are not owned so their interior is not mutable
*s1.field.boxfield = 6; // ERROR
At first glance this might seem like an odd way to deal with mutability, but it seems to work very well with Rust's ownership semantics, and it enables some fascinating patterns that are particularly useful for concurrency. In particular, when combined with explicit self types it allows for 'dual mode' data structures that, under certain circumstances my mutate fields, and under others not, similar to C++ const methods.
struct S {
foo: int
}
impl S {
// Method declared with explicit mutable self type
fn mutate(&mut self) {
self.foo = 10;
}
fn do_not_mutate(&self) {
// Can't mutate fields because we don't have a mutable self pointer
}
}
So you can do neat stuff with this.
// LinearMap is an owned map type in core::send_map
// While it lives in a mutable slot we can call methods that mutate the map
let mut map = LinearMap();
map.insert(foo, bar);
// Move it into an immutable slot and the whole structure becomes 'frozen'
let map = move map;
map.insert(foo, bar); // ERROR
// At this point you can do some interesting things like put your entire map
// into a read-only shared-memory container.
let arc_map = ARC(move map); // ARC: 'atomically-reference-counted'
for repeat(50) {
// Create another handle to the same map
let arc_clone = arc::clone(arc_map);
do spawn |move arc_clone| {
// Read my immutable, shared hash map in parallel with other tasks
}
}
The task creation and lifecycle interface was significantly enhanced, adding more flexibility for grouping tasks according to which should die when a single task fails. There are now methods to spawn tasks with bidirectionally-linked, unidirectionally-linked, and unlinked failure propagation. There is also a low-level mechanism for storing task-local data, which will become the basis for some more advanced error handling mechanisms in future versions.
A new communication system was added in this cycle, called "pipes". This is a lower-level, higher-performance system based on synchronous, 1:1 communication primitives with owned endpoints. Pipes are much friendlier to the memory subsystem of modern hardware and we expect to transition Rust's libraries to use pipes rather than the port/channel system that shipped in previous releases. This transition is not yet complete, but will happen in over subsequent releases.
Rust has no coercion between integral types, so until this release
literals always required an appropriate suffix for types other than
int
, e.g. 12_u8
. This was widely considered an eye-sore and
inconvenience. Now these suffixes can be left off in most situations
and their type will be correctly inferred.
let random_digits: [u8] = [1, 4, 1, 5, 9, 2, 6];
Read the detailed announcement on the mailing list.
Classes are ready for use now, and can contain destructors and implement ifaces. The resource type has been removed in favor of class destructors. In addition, both classes and class methods can have type parameters.
iface talky {
fn speak();
}
iface printable {
fn print();
}
class talker<T: printable> : talky {
let word: T;
new(word: T) {
self.word = word;
}
drop {
self.speak();
}
fn speak() {
self.word.print();
}
}
Closures have a more compact syntax: foo.map( |i| i + 1)
They work with the overhauled for
loops and the new do
expressions to
provide nice sugar for higher-order functions.
for foo.each |i| {
println(#fmt("%?", i));
}
With no arguments these forms are quite minimal.
do spawn {
// this is the body of a closure
}
Read full discussion.
Until now all vectors have been unique types allocated on the exchange heap, but accidental copying of and allocation of vectors turned out to be a major performance hazard.
0.3 features the full complement of vector types demanded by Rust's memory model - in other words you can put vectors on the stack, the local heap or the exchange heap.
// A unique vector, allocated on the exchange heap
let x: ~[int] = ~[0];
// A shared vector, allocated on the local heap
let y: @[int] = @[0];
// A stack vector, allocated on the stack
let z: &[int] = &[0];
The libraries have not fully caught up to the new vector types.
Note:
[]
is currently a synonym for~[]
. It's not clear what the former syntax will end up meaning, possibly a slice or fixed-length vector.
Some posts on vectors that have varying relationships to the final implementation:
We have a new syntax for ignoring variant fields in patterns
alt my_enum {
i_could_match_like_this(_, _, _, _, _, _) {
}
but_would_rather_like_this(*) {
}
}
Rust now has a form of attribute specifically for doc comments. Like other attributes there are different forms depending on whether the documentation is on the outside or the inside of the thing its documenting.
/** Outer doc comment */
fn f() {
/// Outer doc comment
fn g() { }
fn h() {
/*! Inner doc comment */
}
fn i() {
//! Inner doc comment
}
Warnings can be disabled (or enabled or elevated to errors) on a per-item basis, whereas before it was per-crate.
#[warn(no_non_implicitly_copyable_typarams)]
fn implicitly() -> ~[str] {
import std::sort::merge_sort;
merge_sort(str::eq, ~["not_implicitly_copyable"])
}
In this example, merge_sort
will copy the elements of the vector
during sorting, but strings may not be copied without writing copy
(because they are unique types and copying them involves
allocation). In this situation rustc currently emits a warning. As
there is no language-level mechanism yet to authorize the copy,
sometimes you just have to turn the warning off.
Note that the current syntax for disabling warnings by prefixing "no_" to the naming of the warning is confusing and will change.
The warnings (and their default setting) understood by rustc are:
- ctypes (warn) - foreign modules should use core::libc types
- unused_imports (ignore) - disallow imports that are never used
- while_true (warn) - disallow
while true
(should use loop) - path_statement (warn) - writing a statement that names a value without using it is usually a bug
- old_vecs (warn) - use of deprecated vec syntax (
[]
, the meaning of which is likely changing to slice instead of unique vector. the current syntax for unique vectors is~[]
) - old_strs (ignore) - use of deprecated str syntax
- unrecognized_warning
The following are all related to the in-progress effort to eliminate expensive, implicit copies from the language. The current rule is that types that require allocation to copy (unique boxes) or that contain mutable fields are not implicitly copyable. These are warnings now but will be either errors by default or entirely disallowed by the typesystem in the future.
- implicit_copies - performing a copy of a non-implicitly copyable type without
the
copy
keyword - vecs_not_implicitly_copyable - same as above but for vectors
- non_implicitly_copyable_typarams - use of generics whose type parameters
have the
copy
kind with a type that is not implicitly copyable
There has been a lot of progress in converting Rust to a region-based memory model. Although region pointers are not yet ready for use, internally many of rust's analyses have been rewritten in terms of regions.
See Niko's blog posts about regions:
import io::println;
// Typical file info
println(#fmt("%?", #line()));
println(#fmt("%?", #col()));
println(#fmt("%?", #file()));
// The name of the current module, or empty
println(#fmt("%?", #mod()));
let x = 10, y = 15;
// Turn a Rust expression into a string
println(#fmt("%?", #stringify[x + y]));
// Include the contents of a file as a Rust expression
println(#fmt("%?", #include("x_plus_y.rs")));
// Include the contents of a file as a string
println(#fmt("%?", #include_str("x_plus_y.rs")));
// Include the contents of a file as a byte vector
println(#fmt("%?", #include_bin("x_plus_y.rs")));
Rust has a new kind, const
, that can be used as a bounds on type
parameters. A type that is const contains only const fields that are
not mutable. A type that is both const
and send
is appropriate for
using in shared-memory concurrency patterns because it is deeply
immutable and does not contain local box pointers.
This is currently used by core::arc
which provides an atomically
reference counted, sendable type that encapsulates a const
+ send
type.
The word 'native' is being expunged from the language since it implies
that Rust is not native. Native modules are now declared with the
extern
keyword.
extern mod cairo {
Rust functions that can be called from native code with the CDECL ABI, previously called 'crust', are now also declared with the `extern' keyword.
extern fn a_native_callback(user_data: *c_void) {
do_some_crusty_stuff(user_data);
}
These changes are part of a larger plan to overhaul the terminology and syntax around linking.
The first line of a Rust source file can contain a shebang
#! /usr/local/bin/rustx
be
, prove
, syntax
, note
were unimplemented and removed from
the language. mutable
is now written mut
. cont
was renamed
to again
. bind
had too much overlap with other closure forms
while providing subtly different semantics so was removed. do
loops were rarely used, so the do
keyword was repurposed. Resources
were removed in favor of class destructors.
A preliminary reflection system now exists. Type descriptors contain a compiler-generated function that calls visitor-methods on a predefined intrinsic visitor interface. This enables reflecting on a value without knowing its type (with some supporting library work). Much existing code will gradually shift over to this interface, as it subsumes a number of other tasks the compiler and runtime are currently doing as special cases.
There are more methods available on more basic and core types by default now. Methods are generally preferred over functions now when there is a clear 'self' type.
The standard library has a new time
module.
let time: tm = now();
// Convert to a string
println(time.strftime("%D/%M/%Y"));
// tm has some built in conversions
println(time.ctime()); // "Thu Jan 1 00:00:00 1970"
println(time.rfc822()); // "Thu Jan 1 00:00:00 1970"
println(time.rfc3339()); // "2012-02-22T07:53:18-07:00"
Need to write about:
- UV-related APIs
These are a new kind of pointer. In this release, they are written with the sigil &
, which is slightly ambiguous with the argument-mode sigil &
but our longer-term plan is to replace all argument modes with region pointers and remove the concept of argument modes. So this ambiguity was tolerated during this release cycle (we may pick a different sigil later).
Region pointers are cheaper to use than any other sorts of safe pointer in rust; they are statically guaranteed to point to live memory (by construction) so anywhere you are allowed to use them, it is safe to use them, and manipulating them incurs no cost -- not even garbage-collection scanning cost. They are much like C++ &
-references, they way they are idiomatically used. We recommend all signatures to functions be written in terms of region pointers whenever possible. The rust compiler will eventually support automatically "borrowing" the other sorts of pointers into region pointers for the duration of a call, such that region pointers can act as a suitable default for callee signatures.
The previous interface was written in terms of a number of per-platform modules in std
, each of which exposed a sub-module called libc
, as well as some redundant interfaces in std::fs
and std::os_fs
. There was a lot of redundant and poorly-factored, platform-variable code in here. It was consolidated into three files, core::libc
, core::os
, and core::fs
which were platform-conditionalized on an item-by-item basis.
Initial release.