2014-01-28 20:05:57 -06:00
|
|
|
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
|
2012-12-03 18:48:01 -06:00
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#![stable(feature = "rust1", since = "1.0.0")]
|
std: Stabilize unit, bool, ty, tuple, arc, any
This commit applies stability attributes to the contents of these modules,
summarized here:
* The `unit` and `bool` modules have become #[unstable] as they are purely meant
for documentation purposes and are candidates for removal.
* The `ty` module has been deprecated, and the inner `Unsafe` type has been
renamed to `UnsafeCell` and moved to the `cell` module. The `marker1` field
has been removed as the compiler now always infers `UnsafeCell` to be
invariant. The `new` method i stable, but the `value` field, `get` and
`unwrap` methods are all unstable.
* The `tuple` module has its name as stable, the naming of the `TupleN` traits
as stable while the methods are all #[unstable]. The other impls in the module
have appropriate stability for the corresponding trait.
* The `arc` module has received the exact same treatment as the `rc` module
previously did.
* The `any` module has its name as stable. The `Any` trait is also stable, with
a new private supertrait which now contains the `get_type_id` method. This is
to make the method a private implementation detail rather than a public-facing
detail.
The two extension traits in the module are marked #[unstable] as they will not
be necessary with DST. The `is` method is #[stable], the as_{mut,ref} methods
have been renamed to downcast_{mut,ref} and are #[unstable].
The extension trait `BoxAny` has been clarified as to why it is unstable as it
will not be necessary with DST.
This is a breaking change because the `marker1` field was removed from the
`UnsafeCell` type. To deal with this change, you can simply delete the field and
only specify the value of the `data` field in static initializers.
[breaking-change]
2014-07-23 21:10:12 -05:00
|
|
|
|
2014-12-16 19:51:55 -06:00
|
|
|
//! Threadsafe reference-counted boxes (the `Arc<T>` type).
|
|
|
|
//!
|
std: Stabilize the std::fmt module
This commit performs a final stabilization pass over the std::fmt module,
marking all necessary APIs as stable. One of the more interesting aspects of
this module is that it exposes a good deal of its runtime representation to the
outside world in order for `format_args!` to be able to construct the format
strings. Instead of hacking the compiler to assume that these items are stable,
this commit instead lays out a story for the stabilization and evolution of
these APIs.
There are three primary details used by the `format_args!` macro:
1. `Arguments` - an opaque package of a "compiled format string". This structure
is passed around and the `write` function is the source of truth for
transforming a compiled format string into a string at runtime. This must be
able to be constructed in stable code.
2. `Argument` - an opaque structure representing an argument to a format string.
This is *almost* a trait object as it's just a pointer/function pair, but due
to the function originating from one of many traits, it's not actually a
trait object. Like `Arguments`, this must be constructed from stable code.
3. `fmt::rt` - this module contains the runtime type definitions primarily for
the `rt::Argument` structure. Whenever an argument is formatted with
nonstandard flags, a corresponding `rt::Argument` is generated describing how
the argument is being formatted. This can be used to construct an
`Arguments`.
The primary interface to `std::fmt` is the `Arguments` structure, and as such
this type name is stabilize as-is today. It is expected for libraries to pass
around an `Arguments` structure to represent a pending formatted computation.
The remaining portions are largely "cruft" which would rather not be stabilized,
but due to the stability checks they must be. As a result, almost all pieces
have been renamed to represent that they are "version 1" of the formatting
representation. The theory is that at a later date if we change the
representation of these types we can add new definitions called "version 2" and
corresponding constructors for `Arguments`.
One of the other remaining large questions about the fmt module were how the
pending I/O reform would affect the signatures of methods in the module. Due to
[RFC 526][rfc], however, the writers of fmt are now incompatible with the
writers of io, so this question has largely been solved. As a result the
interfaces are largely stabilized as-is today.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0526-fmt-text-writer.md
Specifically, the following changes were made:
* The contents of `fmt::rt` were all moved under `fmt::rt::v1`
* `fmt::rt` is stable
* `fmt::rt::v1` is stable
* `Error` is stable
* `Writer` is stable
* `Writer::write_str` is stable
* `Writer::write_fmt` is stable
* `Formatter` is stable
* `Argument` has been renamed to `ArgumentV1` and is stable
* `ArgumentV1::new` is stable
* `ArgumentV1::from_uint` is stable
* `Arguments::new_v1` is stable (renamed from `new`)
* `Arguments::new_v1_formatted` is stable (renamed from `with_placeholders`)
* All formatting traits are now stable, as well as the `fmt` method.
* `fmt::write` is stable
* `fmt::format` is stable
* `Formatter::pad_integral` is stable
* `Formatter::pad` is stable
* `Formatter::write_str` is stable
* `Formatter::write_fmt` is stable
* Some assorted top level items which were only used by `format_args!` were
removed in favor of static functions on `ArgumentV1` as well.
* The formatting-flag-accessing methods remain unstable
Within the contents of the `fmt::rt::v1` module, the following actions were
taken:
* Reexports of all enum variants were removed
* All prefixes on enum variants were removed
* A few miscellaneous enum variants were renamed
* Otherwise all structs, fields, and variants were marked stable.
In addition to these actions in the `std::fmt` module, many implementations of
`Show` and `String` were stabilized as well.
In some other modules:
* `ToString` is now stable
* `ToString::to_string` is now stable
* `Vec` no longer implements `fmt::Writer` (this has moved to `String`)
This is a breaking change due to all of the changes to the `fmt::rt` module, but
this likely will not have much impact on existing programs.
Closes #20661
[breaking-change]
2015-01-13 17:42:53 -06:00
|
|
|
//! The `Arc<T>` type provides shared ownership of an immutable value.
|
|
|
|
//! Destruction is deterministic, and will occur as soon as the last owner is
|
|
|
|
//! gone. It is marked as `Send` because it uses atomic reference counting.
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
std: Stabilize the std::fmt module
This commit performs a final stabilization pass over the std::fmt module,
marking all necessary APIs as stable. One of the more interesting aspects of
this module is that it exposes a good deal of its runtime representation to the
outside world in order for `format_args!` to be able to construct the format
strings. Instead of hacking the compiler to assume that these items are stable,
this commit instead lays out a story for the stabilization and evolution of
these APIs.
There are three primary details used by the `format_args!` macro:
1. `Arguments` - an opaque package of a "compiled format string". This structure
is passed around and the `write` function is the source of truth for
transforming a compiled format string into a string at runtime. This must be
able to be constructed in stable code.
2. `Argument` - an opaque structure representing an argument to a format string.
This is *almost* a trait object as it's just a pointer/function pair, but due
to the function originating from one of many traits, it's not actually a
trait object. Like `Arguments`, this must be constructed from stable code.
3. `fmt::rt` - this module contains the runtime type definitions primarily for
the `rt::Argument` structure. Whenever an argument is formatted with
nonstandard flags, a corresponding `rt::Argument` is generated describing how
the argument is being formatted. This can be used to construct an
`Arguments`.
The primary interface to `std::fmt` is the `Arguments` structure, and as such
this type name is stabilize as-is today. It is expected for libraries to pass
around an `Arguments` structure to represent a pending formatted computation.
The remaining portions are largely "cruft" which would rather not be stabilized,
but due to the stability checks they must be. As a result, almost all pieces
have been renamed to represent that they are "version 1" of the formatting
representation. The theory is that at a later date if we change the
representation of these types we can add new definitions called "version 2" and
corresponding constructors for `Arguments`.
One of the other remaining large questions about the fmt module were how the
pending I/O reform would affect the signatures of methods in the module. Due to
[RFC 526][rfc], however, the writers of fmt are now incompatible with the
writers of io, so this question has largely been solved. As a result the
interfaces are largely stabilized as-is today.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0526-fmt-text-writer.md
Specifically, the following changes were made:
* The contents of `fmt::rt` were all moved under `fmt::rt::v1`
* `fmt::rt` is stable
* `fmt::rt::v1` is stable
* `Error` is stable
* `Writer` is stable
* `Writer::write_str` is stable
* `Writer::write_fmt` is stable
* `Formatter` is stable
* `Argument` has been renamed to `ArgumentV1` and is stable
* `ArgumentV1::new` is stable
* `ArgumentV1::from_uint` is stable
* `Arguments::new_v1` is stable (renamed from `new`)
* `Arguments::new_v1_formatted` is stable (renamed from `with_placeholders`)
* All formatting traits are now stable, as well as the `fmt` method.
* `fmt::write` is stable
* `fmt::format` is stable
* `Formatter::pad_integral` is stable
* `Formatter::pad` is stable
* `Formatter::write_str` is stable
* `Formatter::write_fmt` is stable
* Some assorted top level items which were only used by `format_args!` were
removed in favor of static functions on `ArgumentV1` as well.
* The formatting-flag-accessing methods remain unstable
Within the contents of the `fmt::rt::v1` module, the following actions were
taken:
* Reexports of all enum variants were removed
* All prefixes on enum variants were removed
* A few miscellaneous enum variants were renamed
* Otherwise all structs, fields, and variants were marked stable.
In addition to these actions in the `std::fmt` module, many implementations of
`Show` and `String` were stabilized as well.
In some other modules:
* `ToString` is now stable
* `ToString::to_string` is now stable
* `Vec` no longer implements `fmt::Writer` (this has moved to `String`)
This is a breaking change due to all of the changes to the `fmt::rt` module, but
this likely will not have much impact on existing programs.
Closes #20661
[breaking-change]
2015-01-13 17:42:53 -06:00
|
|
|
//! If you do not need thread-safety, and just need shared ownership, consider
|
|
|
|
//! the [`Rc<T>` type](../rc/struct.Rc.html). It is the same as `Arc<T>`, but
|
|
|
|
//! does not use atomics, making it both thread-unsafe as well as significantly
|
|
|
|
//! faster when updating the reference count.
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
std: Stabilize the std::fmt module
This commit performs a final stabilization pass over the std::fmt module,
marking all necessary APIs as stable. One of the more interesting aspects of
this module is that it exposes a good deal of its runtime representation to the
outside world in order for `format_args!` to be able to construct the format
strings. Instead of hacking the compiler to assume that these items are stable,
this commit instead lays out a story for the stabilization and evolution of
these APIs.
There are three primary details used by the `format_args!` macro:
1. `Arguments` - an opaque package of a "compiled format string". This structure
is passed around and the `write` function is the source of truth for
transforming a compiled format string into a string at runtime. This must be
able to be constructed in stable code.
2. `Argument` - an opaque structure representing an argument to a format string.
This is *almost* a trait object as it's just a pointer/function pair, but due
to the function originating from one of many traits, it's not actually a
trait object. Like `Arguments`, this must be constructed from stable code.
3. `fmt::rt` - this module contains the runtime type definitions primarily for
the `rt::Argument` structure. Whenever an argument is formatted with
nonstandard flags, a corresponding `rt::Argument` is generated describing how
the argument is being formatted. This can be used to construct an
`Arguments`.
The primary interface to `std::fmt` is the `Arguments` structure, and as such
this type name is stabilize as-is today. It is expected for libraries to pass
around an `Arguments` structure to represent a pending formatted computation.
The remaining portions are largely "cruft" which would rather not be stabilized,
but due to the stability checks they must be. As a result, almost all pieces
have been renamed to represent that they are "version 1" of the formatting
representation. The theory is that at a later date if we change the
representation of these types we can add new definitions called "version 2" and
corresponding constructors for `Arguments`.
One of the other remaining large questions about the fmt module were how the
pending I/O reform would affect the signatures of methods in the module. Due to
[RFC 526][rfc], however, the writers of fmt are now incompatible with the
writers of io, so this question has largely been solved. As a result the
interfaces are largely stabilized as-is today.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0526-fmt-text-writer.md
Specifically, the following changes were made:
* The contents of `fmt::rt` were all moved under `fmt::rt::v1`
* `fmt::rt` is stable
* `fmt::rt::v1` is stable
* `Error` is stable
* `Writer` is stable
* `Writer::write_str` is stable
* `Writer::write_fmt` is stable
* `Formatter` is stable
* `Argument` has been renamed to `ArgumentV1` and is stable
* `ArgumentV1::new` is stable
* `ArgumentV1::from_uint` is stable
* `Arguments::new_v1` is stable (renamed from `new`)
* `Arguments::new_v1_formatted` is stable (renamed from `with_placeholders`)
* All formatting traits are now stable, as well as the `fmt` method.
* `fmt::write` is stable
* `fmt::format` is stable
* `Formatter::pad_integral` is stable
* `Formatter::pad` is stable
* `Formatter::write_str` is stable
* `Formatter::write_fmt` is stable
* Some assorted top level items which were only used by `format_args!` were
removed in favor of static functions on `ArgumentV1` as well.
* The formatting-flag-accessing methods remain unstable
Within the contents of the `fmt::rt::v1` module, the following actions were
taken:
* Reexports of all enum variants were removed
* All prefixes on enum variants were removed
* A few miscellaneous enum variants were renamed
* Otherwise all structs, fields, and variants were marked stable.
In addition to these actions in the `std::fmt` module, many implementations of
`Show` and `String` were stabilized as well.
In some other modules:
* `ToString` is now stable
* `ToString::to_string` is now stable
* `Vec` no longer implements `fmt::Writer` (this has moved to `String`)
This is a breaking change due to all of the changes to the `fmt::rt` module, but
this likely will not have much impact on existing programs.
Closes #20661
[breaking-change]
2015-01-13 17:42:53 -06:00
|
|
|
//! The `downgrade` method can be used to create a non-owning `Weak<T>` pointer
|
|
|
|
//! to the box. A `Weak<T>` pointer can be upgraded to an `Arc<T>` pointer, but
|
|
|
|
//! will return `None` if the value has already been dropped.
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
std: Stabilize the std::fmt module
This commit performs a final stabilization pass over the std::fmt module,
marking all necessary APIs as stable. One of the more interesting aspects of
this module is that it exposes a good deal of its runtime representation to the
outside world in order for `format_args!` to be able to construct the format
strings. Instead of hacking the compiler to assume that these items are stable,
this commit instead lays out a story for the stabilization and evolution of
these APIs.
There are three primary details used by the `format_args!` macro:
1. `Arguments` - an opaque package of a "compiled format string". This structure
is passed around and the `write` function is the source of truth for
transforming a compiled format string into a string at runtime. This must be
able to be constructed in stable code.
2. `Argument` - an opaque structure representing an argument to a format string.
This is *almost* a trait object as it's just a pointer/function pair, but due
to the function originating from one of many traits, it's not actually a
trait object. Like `Arguments`, this must be constructed from stable code.
3. `fmt::rt` - this module contains the runtime type definitions primarily for
the `rt::Argument` structure. Whenever an argument is formatted with
nonstandard flags, a corresponding `rt::Argument` is generated describing how
the argument is being formatted. This can be used to construct an
`Arguments`.
The primary interface to `std::fmt` is the `Arguments` structure, and as such
this type name is stabilize as-is today. It is expected for libraries to pass
around an `Arguments` structure to represent a pending formatted computation.
The remaining portions are largely "cruft" which would rather not be stabilized,
but due to the stability checks they must be. As a result, almost all pieces
have been renamed to represent that they are "version 1" of the formatting
representation. The theory is that at a later date if we change the
representation of these types we can add new definitions called "version 2" and
corresponding constructors for `Arguments`.
One of the other remaining large questions about the fmt module were how the
pending I/O reform would affect the signatures of methods in the module. Due to
[RFC 526][rfc], however, the writers of fmt are now incompatible with the
writers of io, so this question has largely been solved. As a result the
interfaces are largely stabilized as-is today.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0526-fmt-text-writer.md
Specifically, the following changes were made:
* The contents of `fmt::rt` were all moved under `fmt::rt::v1`
* `fmt::rt` is stable
* `fmt::rt::v1` is stable
* `Error` is stable
* `Writer` is stable
* `Writer::write_str` is stable
* `Writer::write_fmt` is stable
* `Formatter` is stable
* `Argument` has been renamed to `ArgumentV1` and is stable
* `ArgumentV1::new` is stable
* `ArgumentV1::from_uint` is stable
* `Arguments::new_v1` is stable (renamed from `new`)
* `Arguments::new_v1_formatted` is stable (renamed from `with_placeholders`)
* All formatting traits are now stable, as well as the `fmt` method.
* `fmt::write` is stable
* `fmt::format` is stable
* `Formatter::pad_integral` is stable
* `Formatter::pad` is stable
* `Formatter::write_str` is stable
* `Formatter::write_fmt` is stable
* Some assorted top level items which were only used by `format_args!` were
removed in favor of static functions on `ArgumentV1` as well.
* The formatting-flag-accessing methods remain unstable
Within the contents of the `fmt::rt::v1` module, the following actions were
taken:
* Reexports of all enum variants were removed
* All prefixes on enum variants were removed
* A few miscellaneous enum variants were renamed
* Otherwise all structs, fields, and variants were marked stable.
In addition to these actions in the `std::fmt` module, many implementations of
`Show` and `String` were stabilized as well.
In some other modules:
* `ToString` is now stable
* `ToString::to_string` is now stable
* `Vec` no longer implements `fmt::Writer` (this has moved to `String`)
This is a breaking change due to all of the changes to the `fmt::rt` module, but
this likely will not have much impact on existing programs.
Closes #20661
[breaking-change]
2015-01-13 17:42:53 -06:00
|
|
|
//! For example, a tree with parent pointers can be represented by putting the
|
|
|
|
//! nodes behind strong `Arc<T>` pointers, and then storing the parent pointers
|
|
|
|
//! as `Weak<T>` pointers.
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
|
|
|
//! # Examples
|
|
|
|
//!
|
|
|
|
//! Sharing some immutable data between tasks:
|
|
|
|
//!
|
2015-03-27 00:11:50 -05:00
|
|
|
//! ```no_run
|
2014-12-16 19:51:55 -06:00
|
|
|
//! use std::sync::Arc;
|
2015-02-17 17:10:25 -06:00
|
|
|
//! use std::thread;
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
2015-01-25 15:05:03 -06:00
|
|
|
//! let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
2015-01-25 04:58:43 -06:00
|
|
|
//! for _ in 0..10 {
|
2014-12-16 19:51:55 -06:00
|
|
|
//! let five = five.clone();
|
|
|
|
//!
|
2015-02-17 17:10:25 -06:00
|
|
|
//! thread::spawn(move || {
|
2015-01-06 18:16:35 -06:00
|
|
|
//! println!("{:?}", five);
|
2015-01-05 23:59:45 -06:00
|
|
|
//! });
|
2014-12-16 19:51:55 -06:00
|
|
|
//! }
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! Sharing mutable data safely between tasks with a `Mutex`:
|
|
|
|
//!
|
2015-03-27 00:11:50 -05:00
|
|
|
//! ```no_run
|
2014-12-21 02:12:56 -06:00
|
|
|
//! use std::sync::{Arc, Mutex};
|
2015-02-17 17:10:25 -06:00
|
|
|
//! use std::thread;
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
2015-01-25 15:05:03 -06:00
|
|
|
//! let five = Arc::new(Mutex::new(5));
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
2015-01-25 04:58:43 -06:00
|
|
|
//! for _ in 0..10 {
|
2014-12-16 19:51:55 -06:00
|
|
|
//! let five = five.clone();
|
|
|
|
//!
|
2015-02-17 17:10:25 -06:00
|
|
|
//! thread::spawn(move || {
|
2014-12-08 22:20:03 -06:00
|
|
|
//! let mut number = five.lock().unwrap();
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
2014-12-21 02:12:56 -06:00
|
|
|
//! *number += 1;
|
2014-12-16 19:51:55 -06:00
|
|
|
//!
|
|
|
|
//! println!("{}", *number); // prints 6
|
2015-01-05 23:59:45 -06:00
|
|
|
//! });
|
2014-12-16 19:51:55 -06:00
|
|
|
//! }
|
|
|
|
//! ```
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2015-02-17 14:41:32 -06:00
|
|
|
use boxed::Box;
|
|
|
|
|
std: Stabilize the std::hash module
This commit aims to prepare the `std::hash` module for alpha by formalizing its
current interface whileholding off on adding `#[stable]` to the new APIs. The
current usage with the `HashMap` and `HashSet` types is also reconciled by
separating out composable parts of the design. The primary goal of this slight
redesign is to separate the concepts of a hasher's state from a hashing
algorithm itself.
The primary change of this commit is to separate the `Hasher` trait into a
`Hasher` and a `HashState` trait. Conceptually the old `Hasher` trait was
actually just a factory for various states, but hashing had very little control
over how these states were used. Additionally the old `Hasher` trait was
actually fairly unrelated to hashing.
This commit redesigns the existing `Hasher` trait to match what the notion of a
`Hasher` normally implies with the following definition:
trait Hasher {
type Output;
fn reset(&mut self);
fn finish(&self) -> Output;
}
This `Hasher` trait emphasizes that hashing algorithms may produce outputs other
than a `u64`, so the output type is made generic. Other than that, however, very
little is assumed about a particular hasher. It is left up to implementors to
provide specific methods or trait implementations to feed data into a hasher.
The corresponding `Hash` trait becomes:
trait Hash<H: Hasher> {
fn hash(&self, &mut H);
}
The old default of `SipState` was removed from this trait as it's not something
that we're willing to stabilize until the end of time, but the type parameter is
always required to implement `Hasher`. Note that the type parameter `H` remains
on the trait to enable multidispatch for specialization of hashing for
particular hashers.
Note that `Writer` is not mentioned in either of `Hash` or `Hasher`, it is
simply used as part `derive` and the implementations for all primitive types.
With these definitions, the old `Hasher` trait is realized as a new `HashState`
trait in the `collections::hash_state` module as an unstable addition for
now. The current definition looks like:
trait HashState {
type Hasher: Hasher;
fn hasher(&self) -> Hasher;
}
The purpose of this trait is to emphasize that the one piece of functionality
for implementors is that new instances of `Hasher` can be created. This
conceptually represents the two keys from which more instances of a
`SipHasher` can be created, and a `HashState` is what's stored in a
`HashMap`, not a `Hasher`.
Implementors of custom hash algorithms should implement the `Hasher` trait, and
only hash algorithms intended for use in hash maps need to implement or worry
about the `HashState` trait.
The entire module and `HashState` infrastructure remains `#[unstable]` due to it
being recently redesigned, but some other stability decision made for the
`std::hash` module are:
* The `Writer` trait remains `#[experimental]` as it's intended to be replaced
with an `io::Writer` (more details soon).
* The top-level `hash` function is `#[unstable]` as it is intended to be generic
over the hashing algorithm instead of hardwired to `SipHasher`
* The inner `sip` module is now private as its one export, `SipHasher` is
reexported in the `hash` module.
And finally, a few changes were made to the default parameters on `HashMap`.
* The `RandomSipHasher` default type parameter was renamed to `RandomState`.
This renaming emphasizes that it is not a hasher, but rather just state to
generate hashers. It also moves away from the name "sip" as it may not always
be implemented as `SipHasher`. This type lives in the
`std::collections::hash_map` module as `#[unstable]`
* The associated `Hasher` type of `RandomState` is creatively called...
`Hasher`! This concrete structure lives next to `RandomState` as an
implemenation of the "default hashing algorithm" used for a `HashMap`. Under
the hood this is currently implemented as `SipHasher`, but it draws an
explicit interface for now and allows us to modify the implementation over
time if necessary.
There are many breaking changes outlined above, and as a result this commit is
a:
[breaking-change]
2014-12-09 14:37:23 -06:00
|
|
|
use core::prelude::*;
|
|
|
|
|
2014-08-04 17:42:36 -05:00
|
|
|
use core::atomic;
|
2014-12-30 12:19:20 -06:00
|
|
|
use core::atomic::Ordering::{Relaxed, Release, Acquire, SeqCst};
|
2015-01-20 17:45:07 -06:00
|
|
|
use core::fmt;
|
2015-03-28 04:23:20 -05:00
|
|
|
use core::cmp::Ordering;
|
2014-10-17 13:00:02 -05:00
|
|
|
use core::default::Default;
|
std: Stabilize the std::hash module
This commit aims to prepare the `std::hash` module for alpha by formalizing its
current interface whileholding off on adding `#[stable]` to the new APIs. The
current usage with the `HashMap` and `HashSet` types is also reconciled by
separating out composable parts of the design. The primary goal of this slight
redesign is to separate the concepts of a hasher's state from a hashing
algorithm itself.
The primary change of this commit is to separate the `Hasher` trait into a
`Hasher` and a `HashState` trait. Conceptually the old `Hasher` trait was
actually just a factory for various states, but hashing had very little control
over how these states were used. Additionally the old `Hasher` trait was
actually fairly unrelated to hashing.
This commit redesigns the existing `Hasher` trait to match what the notion of a
`Hasher` normally implies with the following definition:
trait Hasher {
type Output;
fn reset(&mut self);
fn finish(&self) -> Output;
}
This `Hasher` trait emphasizes that hashing algorithms may produce outputs other
than a `u64`, so the output type is made generic. Other than that, however, very
little is assumed about a particular hasher. It is left up to implementors to
provide specific methods or trait implementations to feed data into a hasher.
The corresponding `Hash` trait becomes:
trait Hash<H: Hasher> {
fn hash(&self, &mut H);
}
The old default of `SipState` was removed from this trait as it's not something
that we're willing to stabilize until the end of time, but the type parameter is
always required to implement `Hasher`. Note that the type parameter `H` remains
on the trait to enable multidispatch for specialization of hashing for
particular hashers.
Note that `Writer` is not mentioned in either of `Hash` or `Hasher`, it is
simply used as part `derive` and the implementations for all primitive types.
With these definitions, the old `Hasher` trait is realized as a new `HashState`
trait in the `collections::hash_state` module as an unstable addition for
now. The current definition looks like:
trait HashState {
type Hasher: Hasher;
fn hasher(&self) -> Hasher;
}
The purpose of this trait is to emphasize that the one piece of functionality
for implementors is that new instances of `Hasher` can be created. This
conceptually represents the two keys from which more instances of a
`SipHasher` can be created, and a `HashState` is what's stored in a
`HashMap`, not a `Hasher`.
Implementors of custom hash algorithms should implement the `Hasher` trait, and
only hash algorithms intended for use in hash maps need to implement or worry
about the `HashState` trait.
The entire module and `HashState` infrastructure remains `#[unstable]` due to it
being recently redesigned, but some other stability decision made for the
`std::hash` module are:
* The `Writer` trait remains `#[experimental]` as it's intended to be replaced
with an `io::Writer` (more details soon).
* The top-level `hash` function is `#[unstable]` as it is intended to be generic
over the hashing algorithm instead of hardwired to `SipHasher`
* The inner `sip` module is now private as its one export, `SipHasher` is
reexported in the `hash` module.
And finally, a few changes were made to the default parameters on `HashMap`.
* The `RandomSipHasher` default type parameter was renamed to `RandomState`.
This renaming emphasizes that it is not a hasher, but rather just state to
generate hashers. It also moves away from the name "sip" as it may not always
be implemented as `SipHasher`. This type lives in the
`std::collections::hash_map` module as `#[unstable]`
* The associated `Hasher` type of `RandomState` is creatively called...
`Hasher`! This concrete structure lives next to `RandomState` as an
implemenation of the "default hashing algorithm" used for a `HashMap`. Under
the hood this is currently implemented as `SipHasher`, but it draws an
explicit interface for now and allows us to modify the implementation over
time if necessary.
There are many breaking changes outlined above, and as a result this commit is
a:
[breaking-change]
2014-12-09 14:37:23 -06:00
|
|
|
use core::mem::{min_align_of, size_of};
|
2014-05-13 18:10:05 -05:00
|
|
|
use core::mem;
|
2014-12-11 21:29:24 -06:00
|
|
|
use core::nonzero::NonZero;
|
std: Stabilize the std::hash module
This commit aims to prepare the `std::hash` module for alpha by formalizing its
current interface whileholding off on adding `#[stable]` to the new APIs. The
current usage with the `HashMap` and `HashSet` types is also reconciled by
separating out composable parts of the design. The primary goal of this slight
redesign is to separate the concepts of a hasher's state from a hashing
algorithm itself.
The primary change of this commit is to separate the `Hasher` trait into a
`Hasher` and a `HashState` trait. Conceptually the old `Hasher` trait was
actually just a factory for various states, but hashing had very little control
over how these states were used. Additionally the old `Hasher` trait was
actually fairly unrelated to hashing.
This commit redesigns the existing `Hasher` trait to match what the notion of a
`Hasher` normally implies with the following definition:
trait Hasher {
type Output;
fn reset(&mut self);
fn finish(&self) -> Output;
}
This `Hasher` trait emphasizes that hashing algorithms may produce outputs other
than a `u64`, so the output type is made generic. Other than that, however, very
little is assumed about a particular hasher. It is left up to implementors to
provide specific methods or trait implementations to feed data into a hasher.
The corresponding `Hash` trait becomes:
trait Hash<H: Hasher> {
fn hash(&self, &mut H);
}
The old default of `SipState` was removed from this trait as it's not something
that we're willing to stabilize until the end of time, but the type parameter is
always required to implement `Hasher`. Note that the type parameter `H` remains
on the trait to enable multidispatch for specialization of hashing for
particular hashers.
Note that `Writer` is not mentioned in either of `Hash` or `Hasher`, it is
simply used as part `derive` and the implementations for all primitive types.
With these definitions, the old `Hasher` trait is realized as a new `HashState`
trait in the `collections::hash_state` module as an unstable addition for
now. The current definition looks like:
trait HashState {
type Hasher: Hasher;
fn hasher(&self) -> Hasher;
}
The purpose of this trait is to emphasize that the one piece of functionality
for implementors is that new instances of `Hasher` can be created. This
conceptually represents the two keys from which more instances of a
`SipHasher` can be created, and a `HashState` is what's stored in a
`HashMap`, not a `Hasher`.
Implementors of custom hash algorithms should implement the `Hasher` trait, and
only hash algorithms intended for use in hash maps need to implement or worry
about the `HashState` trait.
The entire module and `HashState` infrastructure remains `#[unstable]` due to it
being recently redesigned, but some other stability decision made for the
`std::hash` module are:
* The `Writer` trait remains `#[experimental]` as it's intended to be replaced
with an `io::Writer` (more details soon).
* The top-level `hash` function is `#[unstable]` as it is intended to be generic
over the hashing algorithm instead of hardwired to `SipHasher`
* The inner `sip` module is now private as its one export, `SipHasher` is
reexported in the `hash` module.
And finally, a few changes were made to the default parameters on `HashMap`.
* The `RandomSipHasher` default type parameter was renamed to `RandomState`.
This renaming emphasizes that it is not a hasher, but rather just state to
generate hashers. It also moves away from the name "sip" as it may not always
be implemented as `SipHasher`. This type lives in the
`std::collections::hash_map` module as `#[unstable]`
* The associated `Hasher` type of `RandomState` is creatively called...
`Hasher`! This concrete structure lives next to `RandomState` as an
implemenation of the "default hashing algorithm" used for a `HashMap`. Under
the hood this is currently implemented as `SipHasher`, but it draws an
explicit interface for now and allows us to modify the implementation over
time if necessary.
There are many breaking changes outlined above, and as a result this commit is
a:
[breaking-change]
2014-12-09 14:37:23 -06:00
|
|
|
use core::ops::Deref;
|
|
|
|
use core::ptr;
|
|
|
|
use core::hash::{Hash, Hasher};
|
2014-05-13 18:10:05 -05:00
|
|
|
use heap::deallocate;
|
2014-03-22 02:53:58 -05:00
|
|
|
|
|
|
|
/// An atomically reference counted wrapper for shared state.
|
|
|
|
///
|
2015-03-11 20:11:40 -05:00
|
|
|
/// # Examples
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
std: Stabilize the std::fmt module
This commit performs a final stabilization pass over the std::fmt module,
marking all necessary APIs as stable. One of the more interesting aspects of
this module is that it exposes a good deal of its runtime representation to the
outside world in order for `format_args!` to be able to construct the format
strings. Instead of hacking the compiler to assume that these items are stable,
this commit instead lays out a story for the stabilization and evolution of
these APIs.
There are three primary details used by the `format_args!` macro:
1. `Arguments` - an opaque package of a "compiled format string". This structure
is passed around and the `write` function is the source of truth for
transforming a compiled format string into a string at runtime. This must be
able to be constructed in stable code.
2. `Argument` - an opaque structure representing an argument to a format string.
This is *almost* a trait object as it's just a pointer/function pair, but due
to the function originating from one of many traits, it's not actually a
trait object. Like `Arguments`, this must be constructed from stable code.
3. `fmt::rt` - this module contains the runtime type definitions primarily for
the `rt::Argument` structure. Whenever an argument is formatted with
nonstandard flags, a corresponding `rt::Argument` is generated describing how
the argument is being formatted. This can be used to construct an
`Arguments`.
The primary interface to `std::fmt` is the `Arguments` structure, and as such
this type name is stabilize as-is today. It is expected for libraries to pass
around an `Arguments` structure to represent a pending formatted computation.
The remaining portions are largely "cruft" which would rather not be stabilized,
but due to the stability checks they must be. As a result, almost all pieces
have been renamed to represent that they are "version 1" of the formatting
representation. The theory is that at a later date if we change the
representation of these types we can add new definitions called "version 2" and
corresponding constructors for `Arguments`.
One of the other remaining large questions about the fmt module were how the
pending I/O reform would affect the signatures of methods in the module. Due to
[RFC 526][rfc], however, the writers of fmt are now incompatible with the
writers of io, so this question has largely been solved. As a result the
interfaces are largely stabilized as-is today.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0526-fmt-text-writer.md
Specifically, the following changes were made:
* The contents of `fmt::rt` were all moved under `fmt::rt::v1`
* `fmt::rt` is stable
* `fmt::rt::v1` is stable
* `Error` is stable
* `Writer` is stable
* `Writer::write_str` is stable
* `Writer::write_fmt` is stable
* `Formatter` is stable
* `Argument` has been renamed to `ArgumentV1` and is stable
* `ArgumentV1::new` is stable
* `ArgumentV1::from_uint` is stable
* `Arguments::new_v1` is stable (renamed from `new`)
* `Arguments::new_v1_formatted` is stable (renamed from `with_placeholders`)
* All formatting traits are now stable, as well as the `fmt` method.
* `fmt::write` is stable
* `fmt::format` is stable
* `Formatter::pad_integral` is stable
* `Formatter::pad` is stable
* `Formatter::write_str` is stable
* `Formatter::write_fmt` is stable
* Some assorted top level items which were only used by `format_args!` were
removed in favor of static functions on `ArgumentV1` as well.
* The formatting-flag-accessing methods remain unstable
Within the contents of the `fmt::rt::v1` module, the following actions were
taken:
* Reexports of all enum variants were removed
* All prefixes on enum variants were removed
* A few miscellaneous enum variants were renamed
* Otherwise all structs, fields, and variants were marked stable.
In addition to these actions in the `std::fmt` module, many implementations of
`Show` and `String` were stabilized as well.
In some other modules:
* `ToString` is now stable
* `ToString::to_string` is now stable
* `Vec` no longer implements `fmt::Writer` (this has moved to `String`)
This is a breaking change due to all of the changes to the `fmt::rt` module, but
this likely will not have much impact on existing programs.
Closes #20661
[breaking-change]
2015-01-13 17:42:53 -06:00
|
|
|
/// In this example, a large vector of floats is shared between several tasks.
|
|
|
|
/// With simple pipes, without `Arc`, a copy would have to be made for each
|
|
|
|
/// task.
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
2015-03-26 14:05:21 -05:00
|
|
|
/// When you clone an `Arc<T>`, it will create another pointer to the data and
|
|
|
|
/// increase the reference counter.
|
|
|
|
///
|
2015-03-12 21:42:38 -05:00
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc, core)]
|
2014-06-07 13:13:26 -05:00
|
|
|
/// use std::sync::Arc;
|
2015-02-17 17:10:25 -06:00
|
|
|
/// use std::thread;
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
|
|
|
/// fn main() {
|
2015-01-26 14:44:22 -06:00
|
|
|
/// let numbers: Vec<_> = (0..100u32).map(|i| i as f32).collect();
|
2014-03-22 02:53:58 -05:00
|
|
|
/// let shared_numbers = Arc::new(numbers);
|
|
|
|
///
|
2015-01-25 04:58:43 -06:00
|
|
|
/// for _ in 0..10 {
|
2014-03-22 02:53:58 -05:00
|
|
|
/// let child_numbers = shared_numbers.clone();
|
|
|
|
///
|
2015-02-17 17:10:25 -06:00
|
|
|
/// thread::spawn(move || {
|
2014-03-22 02:53:58 -05:00
|
|
|
/// let local_numbers = child_numbers.as_slice();
|
|
|
|
///
|
|
|
|
/// // Work with the local numbers
|
2015-01-05 23:59:45 -06:00
|
|
|
/// });
|
2014-03-22 02:53:58 -05:00
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
#[unsafe_no_drop_flag]
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-03-22 02:53:58 -05:00
|
|
|
pub struct Arc<T> {
|
2014-05-24 06:35:53 -05:00
|
|
|
// FIXME #12808: strange name to try to avoid interfering with
|
|
|
|
// field accesses of the contained type via Deref
|
2014-12-04 12:29:47 -06:00
|
|
|
_ptr: NonZero<*mut ArcInner<T>>,
|
2013-02-26 13:34:00 -06:00
|
|
|
}
|
2012-08-13 18:45:17 -05:00
|
|
|
|
2014-12-24 02:48:11 -06:00
|
|
|
unsafe impl<T: Sync + Send> Send for Arc<T> { }
|
|
|
|
unsafe impl<T: Sync + Send> Sync for Arc<T> { }
|
|
|
|
|
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
/// A weak pointer to an `Arc`.
|
|
|
|
///
|
2015-03-23 17:54:39 -05:00
|
|
|
/// Weak pointers will not keep the data inside of the `Arc` alive, and can be
|
|
|
|
/// used to break cycles between `Arc` pointers.
|
2014-03-22 02:53:58 -05:00
|
|
|
#[unsafe_no_drop_flag]
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc",
|
2015-01-12 20:40:19 -06:00
|
|
|
reason = "Weak pointers may not belong in this module.")]
|
2014-03-22 02:53:58 -05:00
|
|
|
pub struct Weak<T> {
|
2014-05-24 06:35:53 -05:00
|
|
|
// FIXME #12808: strange name to try to avoid interfering with
|
|
|
|
// field accesses of the contained type via Deref
|
2014-12-04 12:29:47 -06:00
|
|
|
_ptr: NonZero<*mut ArcInner<T>>,
|
2012-08-13 18:45:17 -05:00
|
|
|
}
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2014-12-24 02:48:11 -06:00
|
|
|
unsafe impl<T: Sync + Send> Send for Weak<T> { }
|
|
|
|
unsafe impl<T: Sync + Send> Sync for Weak<T> { }
|
2014-12-06 10:39:25 -06:00
|
|
|
|
2015-02-20 06:09:29 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl<T: fmt::Debug> fmt::Debug for Weak<T> {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(f, "(Weak)")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
struct ArcInner<T> {
|
2015-01-10 15:42:48 -06:00
|
|
|
strong: atomic::AtomicUsize,
|
|
|
|
weak: atomic::AtomicUsize,
|
2014-03-22 02:53:58 -05:00
|
|
|
data: T,
|
|
|
|
}
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2014-12-24 02:48:11 -06:00
|
|
|
unsafe impl<T: Sync + Send> Send for ArcInner<T> {}
|
|
|
|
unsafe impl<T: Sync + Send> Sync for ArcInner<T> {}
|
|
|
|
|
2014-12-22 10:15:51 -06:00
|
|
|
impl<T> Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Constructs a new `Arc<T>`.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2013-10-24 15:50:21 -05:00
|
|
|
#[inline]
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2013-07-22 15:57:40 -05:00
|
|
|
pub fn new(data: T) -> Arc<T> {
|
2014-03-22 02:53:58 -05:00
|
|
|
// Start the weak pointer count as 1 which is the weak pointer that's
|
|
|
|
// held by all the strong pointers (kinda), see std/rc.rs for more info
|
2015-02-17 14:41:32 -06:00
|
|
|
let x: Box<_> = box ArcInner {
|
2015-01-10 15:42:48 -06:00
|
|
|
strong: atomic::AtomicUsize::new(1),
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
2014-03-22 02:53:58 -05:00
|
|
|
data: data,
|
|
|
|
};
|
2014-12-04 13:58:21 -06:00
|
|
|
Arc { _ptr: unsafe { NonZero::new(mem::transmute(x)) } }
|
2013-07-22 15:57:40 -05:00
|
|
|
}
|
|
|
|
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Downgrades the `Arc<T>` to a `Weak<T>` reference.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
2014-12-16 19:51:55 -06:00
|
|
|
/// let weak_five = five.downgrade();
|
|
|
|
/// ```
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc",
|
2015-01-12 20:40:19 -06:00
|
|
|
reason = "Weak pointers may not belong in this module.")]
|
2014-03-22 02:53:58 -05:00
|
|
|
pub fn downgrade(&self) -> Weak<T> {
|
|
|
|
// See the clone() impl for why this is relaxed
|
2014-12-30 12:19:20 -06:00
|
|
|
self.inner().weak.fetch_add(1, Relaxed);
|
2014-05-24 06:35:53 -05:00
|
|
|
Weak { _ptr: self._ptr }
|
2013-05-20 05:07:14 -05:00
|
|
|
}
|
|
|
|
}
|
2013-05-24 15:54:58 -05:00
|
|
|
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T> Arc<T> {
|
|
|
|
#[inline]
|
|
|
|
fn inner(&self) -> &ArcInner<T> {
|
2015-02-25 01:27:20 -06:00
|
|
|
// This unsafety is ok because while this arc is alive we're guaranteed
|
|
|
|
// that the inner pointer is valid. Furthermore, we know that the
|
|
|
|
// `ArcInner` structure itself is `Sync` because the inner data is
|
|
|
|
// `Sync` as well, so we're ok loaning out an immutable pointer to these
|
|
|
|
// contents.
|
2014-12-04 13:58:21 -06:00
|
|
|
unsafe { &**self._ptr }
|
2014-10-17 13:00:02 -05:00
|
|
|
}
|
2015-03-18 19:35:11 -05:00
|
|
|
|
|
|
|
// Non-inlined part of `drop`.
|
|
|
|
#[inline(never)]
|
|
|
|
unsafe fn drop_slow(&mut self) {
|
|
|
|
let ptr = *self._ptr;
|
|
|
|
|
2015-03-23 17:54:39 -05:00
|
|
|
// Destroy the data at this time, even though we may not free the box
|
|
|
|
// allocation itself (there may still be weak pointers lying around).
|
2015-03-18 19:35:11 -05:00
|
|
|
drop(ptr::read(&self.inner().data));
|
|
|
|
|
|
|
|
if self.inner().weak.fetch_sub(1, Release) == 1 {
|
|
|
|
atomic::fence(Acquire);
|
|
|
|
deallocate(ptr as *mut u8, size_of::<ArcInner<T>>(), min_align_of::<ArcInner<T>>())
|
|
|
|
}
|
|
|
|
}
|
2014-11-21 16:56:33 -06:00
|
|
|
}
|
2014-11-20 15:38:36 -06:00
|
|
|
|
2014-11-21 16:56:33 -06:00
|
|
|
/// Get the number of weak references to this value.
|
|
|
|
#[inline]
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc")]
|
2015-02-09 01:00:46 -06:00
|
|
|
pub fn weak_count<T>(this: &Arc<T>) -> usize { this.inner().weak.load(SeqCst) - 1 }
|
2014-11-20 15:38:36 -06:00
|
|
|
|
2014-11-21 16:56:33 -06:00
|
|
|
/// Get the number of strong references to this value.
|
|
|
|
#[inline]
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc")]
|
2015-02-09 01:00:46 -06:00
|
|
|
pub fn strong_count<T>(this: &Arc<T>) -> usize { this.inner().strong.load(SeqCst) }
|
2014-10-17 13:00:02 -05:00
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T> Clone for Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Makes a clone of the `Arc<T>`.
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
2014-12-16 19:51:55 -06:00
|
|
|
/// This increases the strong reference count.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// five.clone();
|
|
|
|
/// ```
|
2013-10-24 15:21:49 -05:00
|
|
|
#[inline]
|
2013-07-22 15:57:40 -05:00
|
|
|
fn clone(&self) -> Arc<T> {
|
2015-02-25 01:27:20 -06:00
|
|
|
// Using a relaxed ordering is alright here, as knowledge of the
|
|
|
|
// original reference prevents other threads from erroneously deleting
|
|
|
|
// the object.
|
2014-03-22 02:53:58 -05:00
|
|
|
//
|
2015-02-25 01:27:20 -06:00
|
|
|
// As explained in the [Boost documentation][1], Increasing the
|
|
|
|
// reference counter can always be done with memory_order_relaxed: New
|
|
|
|
// references to an object can only be formed from an existing
|
|
|
|
// reference, and passing an existing reference from one thread to
|
|
|
|
// another must already provide any required synchronization.
|
2014-03-22 02:53:58 -05:00
|
|
|
//
|
|
|
|
// [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
|
2014-12-30 12:19:20 -06:00
|
|
|
self.inner().strong.fetch_add(1, Relaxed);
|
2014-05-24 06:35:53 -05:00
|
|
|
Arc { _ptr: self._ptr }
|
2012-11-26 18:12:47 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-01 13:53:20 -06:00
|
|
|
impl<T> Deref for Arc<T> {
|
|
|
|
type Target = T;
|
|
|
|
|
2013-10-24 15:21:49 -05:00
|
|
|
#[inline]
|
2014-07-29 15:53:40 -05:00
|
|
|
fn deref(&self) -> &T {
|
2014-04-07 19:55:14 -05:00
|
|
|
&self.inner().data
|
2012-08-10 19:46:19 -05:00
|
|
|
}
|
2012-11-26 18:12:47 -06:00
|
|
|
}
|
|
|
|
|
2014-08-05 18:40:04 -05:00
|
|
|
impl<T: Send + Sync + Clone> Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Make a mutable reference from the given `Arc<T>`.
|
|
|
|
///
|
2015-03-23 17:54:39 -05:00
|
|
|
/// This is also referred to as a copy-on-write operation because the inner
|
|
|
|
/// data is cloned if the reference count is greater than one.
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
2014-12-16 19:51:55 -06:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let mut five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// let mut_five = five.make_unique();
|
|
|
|
/// ```
|
2013-06-18 16:45:18 -05:00
|
|
|
#[inline]
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc")]
|
2014-07-29 15:53:40 -05:00
|
|
|
pub fn make_unique(&mut self) -> &mut T {
|
2015-03-23 17:54:39 -05:00
|
|
|
// Note that we hold a strong reference, which also counts as a weak
|
|
|
|
// reference, so we only clone if there is an additional reference of
|
|
|
|
// either kind.
|
2014-12-30 12:19:20 -06:00
|
|
|
if self.inner().strong.load(SeqCst) != 1 ||
|
|
|
|
self.inner().weak.load(SeqCst) != 1 {
|
2014-11-06 16:34:33 -06:00
|
|
|
*self = Arc::new((**self).clone())
|
2012-08-10 19:46:19 -05:00
|
|
|
}
|
2015-03-23 17:54:39 -05:00
|
|
|
// This unsafety is ok because we're guaranteed that the pointer
|
|
|
|
// returned is the *only* pointer that will ever be returned to T. Our
|
|
|
|
// reference count is guaranteed to be 1 at this point, and we required
|
|
|
|
// the Arc itself to be `mut`, so we're returning the only possible
|
|
|
|
// reference to the inner data.
|
2014-12-04 13:58:21 -06:00
|
|
|
let inner = unsafe { &mut **self._ptr };
|
2014-05-28 06:09:50 -05:00
|
|
|
&mut inner.data
|
2012-08-10 19:46:19 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
#[unsafe_destructor]
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-03-21 07:13:07 -05:00
|
|
|
impl<T> Drop for Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Drops the `Arc<T>`.
|
|
|
|
///
|
2015-03-23 17:54:39 -05:00
|
|
|
/// This will decrement the strong reference count. If the strong reference
|
|
|
|
/// count becomes zero and the only other references are `Weak<T>` ones,
|
|
|
|
/// `drop`s the inner value.
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
|
|
|
/// {
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// // stuff
|
|
|
|
///
|
2015-02-04 22:00:02 -06:00
|
|
|
/// drop(five); // explicit drop
|
2014-12-16 19:51:55 -06:00
|
|
|
/// }
|
|
|
|
/// {
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// // stuff
|
|
|
|
///
|
|
|
|
/// } // implicit drop
|
|
|
|
/// ```
|
2015-03-18 19:35:11 -05:00
|
|
|
#[inline]
|
2013-09-16 20:18:07 -05:00
|
|
|
fn drop(&mut self) {
|
2015-03-23 17:54:39 -05:00
|
|
|
// This structure has #[unsafe_no_drop_flag], so this drop glue may run
|
|
|
|
// more than once (but it is guaranteed to be zeroed after the first if
|
|
|
|
// it's run more than once)
|
2014-12-04 13:58:21 -06:00
|
|
|
let ptr = *self._ptr;
|
2015-02-10 03:04:39 -06:00
|
|
|
// if ptr.is_null() { return }
|
|
|
|
if ptr.is_null() || ptr as usize == mem::POST_DROP_USIZE { return }
|
2014-03-22 02:53:58 -05:00
|
|
|
|
2015-03-23 17:54:39 -05:00
|
|
|
// Because `fetch_sub` is already atomic, we do not need to synchronize
|
|
|
|
// with other threads unless we are going to delete the object. This
|
|
|
|
// same logic applies to the below `fetch_sub` to the `weak` count.
|
2014-12-30 12:19:20 -06:00
|
|
|
if self.inner().strong.fetch_sub(1, Release) != 1 { return }
|
2014-03-22 02:53:58 -05:00
|
|
|
|
2015-03-23 17:54:39 -05:00
|
|
|
// This fence is needed to prevent reordering of use of the data and
|
|
|
|
// deletion of the data. Because it is marked `Release`, the decreasing
|
|
|
|
// of the reference count synchronizes with this `Acquire` fence. This
|
|
|
|
// means that use of the data happens before decreasing the reference
|
|
|
|
// count, which happens before this fence, which happens before the
|
|
|
|
// deletion of the data.
|
2014-03-22 02:53:58 -05:00
|
|
|
//
|
|
|
|
// As explained in the [Boost documentation][1],
|
|
|
|
//
|
2015-03-23 17:54:39 -05:00
|
|
|
// > It is important to enforce any possible access to the object in one
|
|
|
|
// > thread (through an existing reference) to *happen before* deleting
|
|
|
|
// > the object in a different thread. This is achieved by a "release"
|
|
|
|
// > operation after dropping a reference (any access to the object
|
|
|
|
// > through this reference must obviously happened before), and an
|
|
|
|
// > "acquire" operation before deleting the object.
|
2014-03-22 02:53:58 -05:00
|
|
|
//
|
|
|
|
// [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
|
2014-12-30 12:19:20 -06:00
|
|
|
atomic::fence(Acquire);
|
2014-03-22 02:53:58 -05:00
|
|
|
|
2015-03-18 19:35:11 -05:00
|
|
|
unsafe {
|
|
|
|
self.drop_slow()
|
2013-01-23 20:15:06 -06:00
|
|
|
}
|
2012-08-13 18:45:17 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc",
|
2015-01-12 20:40:19 -06:00
|
|
|
reason = "Weak pointers may not belong in this module.")]
|
2015-03-21 07:13:07 -05:00
|
|
|
impl<T> Weak<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Upgrades a weak reference to a strong reference.
|
|
|
|
///
|
|
|
|
/// Upgrades the `Weak<T>` reference to an `Arc<T>`, if possible.
|
|
|
|
///
|
2015-03-23 17:54:39 -05:00
|
|
|
/// Returns `None` if there were no strong references and the data was
|
|
|
|
/// destroyed.
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-03-22 02:53:58 -05:00
|
|
|
///
|
2014-12-16 19:51:55 -06:00
|
|
|
/// let weak_five = five.downgrade();
|
|
|
|
///
|
|
|
|
/// let strong_five: Option<Arc<_>> = weak_five.upgrade();
|
|
|
|
/// ```
|
2014-03-22 02:53:58 -05:00
|
|
|
pub fn upgrade(&self) -> Option<Arc<T>> {
|
2015-03-23 17:54:39 -05:00
|
|
|
// We use a CAS loop to increment the strong count instead of a
|
|
|
|
// fetch_add because once the count hits 0 is must never be above 0.
|
2014-03-22 02:53:58 -05:00
|
|
|
let inner = self.inner();
|
|
|
|
loop {
|
2014-12-30 12:19:20 -06:00
|
|
|
let n = inner.strong.load(SeqCst);
|
2014-03-22 02:53:58 -05:00
|
|
|
if n == 0 { return None }
|
2014-12-30 12:19:20 -06:00
|
|
|
let old = inner.strong.compare_and_swap(n, n + 1, SeqCst);
|
2014-05-24 06:35:53 -05:00
|
|
|
if old == n { return Some(Arc { _ptr: self._ptr }) }
|
2013-12-21 21:53:43 -06:00
|
|
|
}
|
2012-09-04 19:22:09 -05:00
|
|
|
}
|
|
|
|
|
2013-10-24 15:21:49 -05:00
|
|
|
#[inline]
|
2014-07-29 15:53:40 -05:00
|
|
|
fn inner(&self) -> &ArcInner<T> {
|
2014-03-22 02:53:58 -05:00
|
|
|
// See comments above for why this is "safe"
|
2014-12-04 13:58:21 -06:00
|
|
|
unsafe { &**self._ptr }
|
2012-08-10 19:46:19 -05:00
|
|
|
}
|
2012-11-26 18:12:47 -06:00
|
|
|
}
|
|
|
|
|
2015-01-22 20:22:03 -06:00
|
|
|
#[unstable(feature = "alloc",
|
2015-01-12 20:40:19 -06:00
|
|
|
reason = "Weak pointers may not belong in this module.")]
|
2014-08-05 18:40:04 -05:00
|
|
|
impl<T: Sync + Send> Clone for Weak<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Makes a clone of the `Weak<T>`.
|
|
|
|
///
|
|
|
|
/// This increases the weak reference count.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let weak_five = Arc::new(5).downgrade();
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
|
|
|
/// weak_five.clone();
|
|
|
|
/// ```
|
2013-06-18 16:45:18 -05:00
|
|
|
#[inline]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn clone(&self) -> Weak<T> {
|
|
|
|
// See comments in Arc::clone() for why this is relaxed
|
2014-12-30 12:19:20 -06:00
|
|
|
self.inner().weak.fetch_add(1, Relaxed);
|
2014-05-24 06:35:53 -05:00
|
|
|
Weak { _ptr: self._ptr }
|
2012-08-14 12:32:41 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
#[unsafe_destructor]
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-03-21 07:13:07 -05:00
|
|
|
impl<T> Drop for Weak<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Drops the `Weak<T>`.
|
|
|
|
///
|
|
|
|
/// This will decrement the weak reference count.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2015-03-13 17:28:35 -05:00
|
|
|
/// # #![feature(alloc)]
|
2014-12-16 19:51:55 -06:00
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
|
|
|
/// {
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// let weak_five = five.downgrade();
|
|
|
|
///
|
|
|
|
/// // stuff
|
|
|
|
///
|
2015-02-04 22:00:02 -06:00
|
|
|
/// drop(weak_five); // explicit drop
|
2014-12-16 19:51:55 -06:00
|
|
|
/// }
|
|
|
|
/// {
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// let weak_five = five.downgrade();
|
|
|
|
///
|
|
|
|
/// // stuff
|
|
|
|
///
|
|
|
|
/// } // implicit drop
|
|
|
|
/// ```
|
2014-03-22 02:53:58 -05:00
|
|
|
fn drop(&mut self) {
|
2014-12-04 13:58:21 -06:00
|
|
|
let ptr = *self._ptr;
|
2014-12-04 12:29:47 -06:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
// see comments above for why this check is here
|
2015-02-10 03:04:39 -06:00
|
|
|
if ptr.is_null() || ptr as usize == mem::POST_DROP_USIZE { return }
|
2014-03-22 02:53:58 -05:00
|
|
|
|
2015-03-23 17:54:39 -05:00
|
|
|
// If we find out that we were the last weak pointer, then its time to
|
|
|
|
// deallocate the data entirely. See the discussion in Arc::drop() about
|
|
|
|
// the memory orderings
|
2014-12-30 12:19:20 -06:00
|
|
|
if self.inner().weak.fetch_sub(1, Release) == 1 {
|
|
|
|
atomic::fence(Acquire);
|
2014-12-04 12:29:47 -06:00
|
|
|
unsafe { deallocate(ptr as *mut u8, size_of::<ArcInner<T>>(),
|
2014-05-11 17:41:01 -05:00
|
|
|
min_align_of::<ArcInner<T>>()) }
|
2013-12-30 18:17:35 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T: PartialEq> PartialEq for Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Equality for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// Two `Arc<T>`s are equal if their inner value are equal.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five == Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn eq(&self, other: &Arc<T>) -> bool { *(*self) == *(*other) }
|
2014-12-16 19:51:55 -06:00
|
|
|
|
|
|
|
/// Inequality for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// Two `Arc<T>`s are unequal if their inner value are unequal.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five != Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn ne(&self, other: &Arc<T>) -> bool { *(*self) != *(*other) }
|
|
|
|
}
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T: PartialOrd> PartialOrd for Arc<T> {
|
2014-12-16 19:51:55 -06:00
|
|
|
/// Partial comparison for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// The two are compared by calling `partial_cmp()` on their inner values.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five.partial_cmp(&Arc::new(5));
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
|
|
|
|
(**self).partial_cmp(&**other)
|
|
|
|
}
|
2014-12-16 19:51:55 -06:00
|
|
|
|
|
|
|
/// Less-than comparison for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// The two are compared by calling `<` on their inner values.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five < Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn lt(&self, other: &Arc<T>) -> bool { *(*self) < *(*other) }
|
2014-12-16 19:51:55 -06:00
|
|
|
|
|
|
|
/// 'Less-than or equal to' comparison for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// The two are compared by calling `<=` on their inner values.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five <= Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn le(&self, other: &Arc<T>) -> bool { *(*self) <= *(*other) }
|
2014-12-16 19:51:55 -06:00
|
|
|
|
|
|
|
/// Greater-than comparison for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// The two are compared by calling `>` on their inner values.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five > Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
2014-10-17 13:00:02 -05:00
|
|
|
fn gt(&self, other: &Arc<T>) -> bool { *(*self) > *(*other) }
|
2014-12-16 19:51:55 -06:00
|
|
|
|
|
|
|
/// 'Greater-than or equal to' comparison for two `Arc<T>`s.
|
|
|
|
///
|
|
|
|
/// The two are compared by calling `>=` on their inner values.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// let five = Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
///
|
2015-01-25 15:05:03 -06:00
|
|
|
/// five >= Arc::new(5);
|
2014-12-16 19:51:55 -06:00
|
|
|
/// ```
|
|
|
|
fn ge(&self, other: &Arc<T>) -> bool { *(*self) >= *(*other) }
|
2014-10-17 13:00:02 -05:00
|
|
|
}
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T: Ord> Ord for Arc<T> {
|
|
|
|
fn cmp(&self, other: &Arc<T>) -> Ordering { (**self).cmp(&**other) }
|
|
|
|
}
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T: Eq> Eq for Arc<T> {}
|
|
|
|
|
2015-01-24 11:15:42 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-20 17:45:07 -06:00
|
|
|
impl<T: fmt::Display> fmt::Display for Arc<T> {
|
2014-10-17 13:00:02 -05:00
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
2015-01-20 17:45:07 -06:00
|
|
|
fmt::Display::fmt(&**self, f)
|
2014-10-17 13:00:02 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-20 17:45:07 -06:00
|
|
|
impl<T: fmt::Debug> fmt::Debug for Arc<T> {
|
2015-01-07 16:58:31 -06:00
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
2015-01-20 17:45:07 -06:00
|
|
|
fmt::Debug::fmt(&**self, f)
|
2015-01-07 16:58:31 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
impl<T: Default + Sync + Send> Default for Arc<T> {
|
2015-01-23 23:48:20 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2014-10-17 13:00:02 -05:00
|
|
|
fn default() -> Arc<T> { Arc::new(Default::default()) }
|
|
|
|
}
|
|
|
|
|
2015-02-17 22:48:07 -06:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl<T: Hash> Hash for Arc<T> {
|
|
|
|
fn hash<H: Hasher>(&self, state: &mut H) {
|
|
|
|
(**self).hash(state)
|
|
|
|
}
|
|
|
|
}
|
std: Stabilize the std::hash module
This commit aims to prepare the `std::hash` module for alpha by formalizing its
current interface whileholding off on adding `#[stable]` to the new APIs. The
current usage with the `HashMap` and `HashSet` types is also reconciled by
separating out composable parts of the design. The primary goal of this slight
redesign is to separate the concepts of a hasher's state from a hashing
algorithm itself.
The primary change of this commit is to separate the `Hasher` trait into a
`Hasher` and a `HashState` trait. Conceptually the old `Hasher` trait was
actually just a factory for various states, but hashing had very little control
over how these states were used. Additionally the old `Hasher` trait was
actually fairly unrelated to hashing.
This commit redesigns the existing `Hasher` trait to match what the notion of a
`Hasher` normally implies with the following definition:
trait Hasher {
type Output;
fn reset(&mut self);
fn finish(&self) -> Output;
}
This `Hasher` trait emphasizes that hashing algorithms may produce outputs other
than a `u64`, so the output type is made generic. Other than that, however, very
little is assumed about a particular hasher. It is left up to implementors to
provide specific methods or trait implementations to feed data into a hasher.
The corresponding `Hash` trait becomes:
trait Hash<H: Hasher> {
fn hash(&self, &mut H);
}
The old default of `SipState` was removed from this trait as it's not something
that we're willing to stabilize until the end of time, but the type parameter is
always required to implement `Hasher`. Note that the type parameter `H` remains
on the trait to enable multidispatch for specialization of hashing for
particular hashers.
Note that `Writer` is not mentioned in either of `Hash` or `Hasher`, it is
simply used as part `derive` and the implementations for all primitive types.
With these definitions, the old `Hasher` trait is realized as a new `HashState`
trait in the `collections::hash_state` module as an unstable addition for
now. The current definition looks like:
trait HashState {
type Hasher: Hasher;
fn hasher(&self) -> Hasher;
}
The purpose of this trait is to emphasize that the one piece of functionality
for implementors is that new instances of `Hasher` can be created. This
conceptually represents the two keys from which more instances of a
`SipHasher` can be created, and a `HashState` is what's stored in a
`HashMap`, not a `Hasher`.
Implementors of custom hash algorithms should implement the `Hasher` trait, and
only hash algorithms intended for use in hash maps need to implement or worry
about the `HashState` trait.
The entire module and `HashState` infrastructure remains `#[unstable]` due to it
being recently redesigned, but some other stability decision made for the
`std::hash` module are:
* The `Writer` trait remains `#[experimental]` as it's intended to be replaced
with an `io::Writer` (more details soon).
* The top-level `hash` function is `#[unstable]` as it is intended to be generic
over the hashing algorithm instead of hardwired to `SipHasher`
* The inner `sip` module is now private as its one export, `SipHasher` is
reexported in the `hash` module.
And finally, a few changes were made to the default parameters on `HashMap`.
* The `RandomSipHasher` default type parameter was renamed to `RandomState`.
This renaming emphasizes that it is not a hasher, but rather just state to
generate hashers. It also moves away from the name "sip" as it may not always
be implemented as `SipHasher`. This type lives in the
`std::collections::hash_map` module as `#[unstable]`
* The associated `Hasher` type of `RandomState` is creatively called...
`Hasher`! This concrete structure lives next to `RandomState` as an
implemenation of the "default hashing algorithm" used for a `HashMap`. Under
the hood this is currently implemented as `SipHasher`, but it draws an
explicit interface for now and allows us to modify the implementation over
time if necessary.
There are many breaking changes outlined above, and as a result this commit is
a:
[breaking-change]
2014-12-09 14:37:23 -06:00
|
|
|
|
2012-08-10 17:20:03 -05:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2014-05-13 18:10:05 -05:00
|
|
|
use std::clone::Clone;
|
2014-12-23 13:53:35 -06:00
|
|
|
use std::sync::mpsc::channel;
|
2014-05-13 18:10:05 -05:00
|
|
|
use std::mem::drop;
|
2014-05-24 06:35:53 -05:00
|
|
|
use std::ops::Drop;
|
2014-11-28 10:57:41 -06:00
|
|
|
use std::option::Option;
|
|
|
|
use std::option::Option::{Some, None};
|
2014-08-04 17:42:36 -05:00
|
|
|
use std::sync::atomic;
|
2014-12-30 18:29:27 -06:00
|
|
|
use std::sync::atomic::Ordering::{Acquire, SeqCst};
|
2015-02-17 17:10:25 -06:00
|
|
|
use std::thread;
|
2014-05-13 18:10:05 -05:00
|
|
|
use std::vec::Vec;
|
2014-11-21 16:56:33 -06:00
|
|
|
use super::{Arc, Weak, weak_count, strong_count};
|
2014-06-07 13:13:26 -05:00
|
|
|
use std::sync::Mutex;
|
2012-12-28 14:46:08 -06:00
|
|
|
|
2015-01-10 15:42:48 -06:00
|
|
|
struct Canary(*mut atomic::AtomicUsize);
|
2014-03-30 12:06:24 -05:00
|
|
|
|
|
|
|
impl Drop for Canary
|
|
|
|
{
|
|
|
|
fn drop(&mut self) {
|
|
|
|
unsafe {
|
|
|
|
match *self {
|
|
|
|
Canary(c) => {
|
2014-12-30 12:19:20 -06:00
|
|
|
(*c).fetch_add(1, SeqCst);
|
2014-03-30 12:06:24 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2013-05-24 21:35:29 -05:00
|
|
|
|
2012-08-10 17:20:03 -05:00
|
|
|
#[test]
|
2013-04-15 10:08:52 -05:00
|
|
|
fn manually_share_arc() {
|
2014-03-05 17:28:08 -06:00
|
|
|
let v = vec!(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
|
2013-07-22 15:57:40 -05:00
|
|
|
let arc_v = Arc::new(v);
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2014-03-09 16:58:32 -05:00
|
|
|
let (tx, rx) = channel();
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2015-02-17 17:10:25 -06:00
|
|
|
let _t = thread::spawn(move || {
|
2015-02-09 01:00:46 -06:00
|
|
|
let arc_v: Arc<Vec<i32>> = rx.recv().unwrap();
|
2014-09-22 12:30:06 -05:00
|
|
|
assert_eq!((*arc_v)[3], 4);
|
2014-01-26 22:13:24 -06:00
|
|
|
});
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2014-12-23 13:53:35 -06:00
|
|
|
tx.send(arc_v.clone()).unwrap();
|
2012-08-10 17:20:03 -05:00
|
|
|
|
2014-09-22 12:30:06 -05:00
|
|
|
assert_eq!((*arc_v)[2], 3);
|
|
|
|
assert_eq!((*arc_v)[4], 5);
|
2012-08-10 17:20:03 -05:00
|
|
|
}
|
2012-08-10 19:46:19 -05:00
|
|
|
|
2012-08-13 18:45:17 -05:00
|
|
|
#[test]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn test_cowarc_clone_make_unique() {
|
2015-01-25 04:58:43 -06:00
|
|
|
let mut cow0 = Arc::new(75);
|
2014-03-22 02:53:58 -05:00
|
|
|
let mut cow1 = cow0.clone();
|
|
|
|
let mut cow2 = cow1.clone();
|
2012-09-18 23:41:37 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
assert!(75 == *cow0.make_unique());
|
|
|
|
assert!(75 == *cow1.make_unique());
|
|
|
|
assert!(75 == *cow2.make_unique());
|
2012-09-18 23:41:37 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
*cow0.make_unique() += 1;
|
|
|
|
*cow1.make_unique() += 2;
|
|
|
|
*cow2.make_unique() += 3;
|
2012-09-18 23:41:37 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
assert!(76 == *cow0);
|
|
|
|
assert!(77 == *cow1);
|
|
|
|
assert!(78 == *cow2);
|
2013-12-21 21:53:43 -06:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
// none should point to the same backing memory
|
|
|
|
assert!(*cow0 != *cow1);
|
|
|
|
assert!(*cow0 != *cow2);
|
|
|
|
assert!(*cow1 != *cow2);
|
2013-12-21 21:53:43 -06:00
|
|
|
}
|
|
|
|
|
2012-08-14 12:32:41 -05:00
|
|
|
#[test]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn test_cowarc_clone_unique2() {
|
2015-01-25 04:58:43 -06:00
|
|
|
let mut cow0 = Arc::new(75);
|
2014-03-22 02:53:58 -05:00
|
|
|
let cow1 = cow0.clone();
|
|
|
|
let cow2 = cow1.clone();
|
2013-06-12 16:46:28 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
assert!(75 == *cow0);
|
|
|
|
assert!(75 == *cow1);
|
|
|
|
assert!(75 == *cow2);
|
2013-06-12 16:46:28 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
*cow0.make_unique() += 1;
|
2013-06-12 16:46:28 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
assert!(76 == *cow0);
|
|
|
|
assert!(75 == *cow1);
|
|
|
|
assert!(75 == *cow2);
|
2013-06-12 16:46:28 -05:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
// cow1 and cow2 should share the same contents
|
|
|
|
// cow0 should have a unique reference
|
|
|
|
assert!(*cow0 != *cow1);
|
|
|
|
assert!(*cow0 != *cow2);
|
|
|
|
assert!(*cow1 == *cow2);
|
2013-06-12 16:46:28 -05:00
|
|
|
}
|
2013-12-30 18:17:35 -06:00
|
|
|
|
2014-05-29 13:49:01 -05:00
|
|
|
#[test]
|
|
|
|
fn test_cowarc_clone_weak() {
|
2015-01-25 04:58:43 -06:00
|
|
|
let mut cow0 = Arc::new(75);
|
2014-05-29 13:49:01 -05:00
|
|
|
let cow1_weak = cow0.downgrade();
|
|
|
|
|
|
|
|
assert!(75 == *cow0);
|
|
|
|
assert!(75 == *cow1_weak.upgrade().unwrap());
|
|
|
|
|
|
|
|
*cow0.make_unique() += 1;
|
|
|
|
|
|
|
|
assert!(76 == *cow0);
|
|
|
|
assert!(cow1_weak.upgrade().is_none());
|
|
|
|
}
|
|
|
|
|
2013-12-30 18:17:35 -06:00
|
|
|
#[test]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn test_live() {
|
2015-01-25 15:05:03 -06:00
|
|
|
let x = Arc::new(5);
|
2014-03-22 02:53:58 -05:00
|
|
|
let y = x.downgrade();
|
|
|
|
assert!(y.upgrade().is_some());
|
2013-12-30 18:17:35 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn test_dead() {
|
2015-01-25 15:05:03 -06:00
|
|
|
let x = Arc::new(5);
|
2014-03-22 02:53:58 -05:00
|
|
|
let y = x.downgrade();
|
|
|
|
drop(x);
|
|
|
|
assert!(y.upgrade().is_none());
|
2013-12-30 18:17:35 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2014-03-22 02:53:58 -05:00
|
|
|
fn weak_self_cyclic() {
|
|
|
|
struct Cycle {
|
|
|
|
x: Mutex<Option<Weak<Cycle>>>
|
|
|
|
}
|
2013-12-30 18:17:35 -06:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
let a = Arc::new(Cycle { x: Mutex::new(None) });
|
|
|
|
let b = a.clone().downgrade();
|
2014-12-08 22:20:03 -06:00
|
|
|
*a.x.lock().unwrap() = Some(b);
|
2013-12-30 18:17:35 -06:00
|
|
|
|
2014-03-22 02:53:58 -05:00
|
|
|
// hopefully we don't double-free (or leak)...
|
2013-12-30 18:17:35 -06:00
|
|
|
}
|
2014-03-30 12:06:24 -05:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn drop_arc() {
|
2015-01-10 15:42:48 -06:00
|
|
|
let mut canary = atomic::AtomicUsize::new(0);
|
|
|
|
let x = Arc::new(Canary(&mut canary as *mut atomic::AtomicUsize));
|
2014-03-30 12:06:24 -05:00
|
|
|
drop(x);
|
2014-12-30 12:19:20 -06:00
|
|
|
assert!(canary.load(Acquire) == 1);
|
2014-03-30 12:06:24 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn drop_arc_weak() {
|
2015-01-10 15:42:48 -06:00
|
|
|
let mut canary = atomic::AtomicUsize::new(0);
|
|
|
|
let arc = Arc::new(Canary(&mut canary as *mut atomic::AtomicUsize));
|
2014-03-30 12:06:24 -05:00
|
|
|
let arc_weak = arc.downgrade();
|
2014-12-30 12:19:20 -06:00
|
|
|
assert!(canary.load(Acquire) == 0);
|
2014-03-30 12:06:24 -05:00
|
|
|
drop(arc);
|
2014-12-30 12:19:20 -06:00
|
|
|
assert!(canary.load(Acquire) == 1);
|
2014-03-30 12:06:24 -05:00
|
|
|
drop(arc_weak);
|
|
|
|
}
|
2014-10-26 06:58:04 -05:00
|
|
|
|
2014-11-20 15:38:36 -06:00
|
|
|
#[test]
|
|
|
|
fn test_strong_count() {
|
|
|
|
let a = Arc::new(0u32);
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&a) == 1);
|
2014-11-20 15:38:36 -06:00
|
|
|
let w = a.downgrade();
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&a) == 1);
|
2014-11-20 15:38:36 -06:00
|
|
|
let b = w.upgrade().expect("");
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&b) == 2);
|
|
|
|
assert!(strong_count(&a) == 2);
|
2014-11-20 15:38:36 -06:00
|
|
|
drop(w);
|
|
|
|
drop(a);
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&b) == 1);
|
2014-11-20 15:38:36 -06:00
|
|
|
let c = b.clone();
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&b) == 2);
|
|
|
|
assert!(strong_count(&c) == 2);
|
2014-11-20 15:38:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_weak_count() {
|
|
|
|
let a = Arc::new(0u32);
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&a) == 1);
|
|
|
|
assert!(weak_count(&a) == 0);
|
2014-11-20 15:38:36 -06:00
|
|
|
let w = a.downgrade();
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&a) == 1);
|
|
|
|
assert!(weak_count(&a) == 1);
|
|
|
|
let x = w.clone();
|
|
|
|
assert!(weak_count(&a) == 2);
|
2014-11-20 15:38:36 -06:00
|
|
|
drop(w);
|
2014-11-21 16:56:33 -06:00
|
|
|
drop(x);
|
|
|
|
assert!(strong_count(&a) == 1);
|
|
|
|
assert!(weak_count(&a) == 0);
|
2014-11-20 15:38:36 -06:00
|
|
|
let c = a.clone();
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(strong_count(&a) == 2);
|
|
|
|
assert!(weak_count(&a) == 0);
|
2014-11-20 15:38:36 -06:00
|
|
|
let d = c.downgrade();
|
2014-11-21 16:56:33 -06:00
|
|
|
assert!(weak_count(&c) == 1);
|
|
|
|
assert!(strong_count(&c) == 2);
|
2014-11-20 15:38:36 -06:00
|
|
|
|
|
|
|
drop(a);
|
|
|
|
drop(c);
|
|
|
|
drop(d);
|
|
|
|
}
|
|
|
|
|
2014-10-26 06:58:04 -05:00
|
|
|
#[test]
|
|
|
|
fn show_arc() {
|
|
|
|
let a = Arc::new(5u32);
|
2015-01-20 17:45:07 -06:00
|
|
|
assert_eq!(format!("{:?}", a), "5");
|
2014-10-26 06:58:04 -05:00
|
|
|
}
|
2014-10-17 13:00:02 -05:00
|
|
|
|
|
|
|
// Make sure deriving works with Arc<T>
|
2015-01-28 07:34:18 -06:00
|
|
|
#[derive(Eq, Ord, PartialEq, PartialOrd, Clone, Debug, Default)]
|
2015-02-09 01:00:46 -06:00
|
|
|
struct Foo { inner: Arc<i32> }
|
2012-08-10 17:20:03 -05:00
|
|
|
}
|