diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 100644 index 7d4ef9c..0000000 --- a/SUMMARY.md +++ /dev/null @@ -1,53 +0,0 @@ -# Summary - -* [Meet Safe and Unsafe](meet-safe-and-unsafe.md) - * [How Safe and Unsafe Interact](safe-unsafe-meaning.md) - * [Working with Unsafe](working-with-unsafe.md) -* [Data Layout](data.md) - * [repr(Rust)](repr-rust.md) - * [Exotically Sized Types](exotic-sizes.md) - * [Other reprs](other-reprs.md) -* [Ownership](ownership.md) - * [References](references.md) - * [Lifetimes](lifetimes.md) - * [Limits of Lifetimes](lifetime-mismatch.md) - * [Lifetime Elision](lifetime-elision.md) - * [Unbounded Lifetimes](unbounded-lifetimes.md) - * [Higher-Rank Trait Bounds](hrtb.md) - * [Subtyping and Variance](subtyping.md) - * [Drop Check](dropck.md) - * [PhantomData](phantom-data.md) - * [Splitting Borrows](borrow-splitting.md) -* [Type Conversions](conversions.md) - * [Coercions](coercions.md) - * [The Dot Operator](dot-operator.md) - * [Casts](casts.md) - * [Transmutes](transmutes.md) -* [Uninitialized Memory](uninitialized.md) - * [Checked](checked-uninit.md) - * [Drop Flags](drop-flags.md) - * [Unchecked](unchecked-uninit.md) -* [Ownership Based Resource Management](obrm.md) - * [Constructors](constructors.md) - * [Destructors](destructors.md) - * [Leaking](leaking.md) -* [Unwinding](unwinding.md) - * [Exception Safety](exception-safety.md) - * [Poisoning](poisoning.md) -* [Concurrency](concurrency.md) - * [Races](races.md) - * [Send and Sync](send-and-sync.md) - * [Atomics](atomics.md) -* [Implementing Vec](vec.md) - * [Layout](vec-layout.md) - * [Allocating](vec-alloc.md) - * [Push and Pop](vec-push-pop.md) - * [Deallocating](vec-dealloc.md) - * [Deref](vec-deref.md) - * [Insert and Remove](vec-insert-remove.md) - * [IntoIter](vec-into-iter.md) - * [RawVec](vec-raw.md) - * [Drain](vec-drain.md) - * [Handling Zero-Sized Types](vec-zsts.md) - * [Final Code](vec-final.md) -* [Implementing Arc and Mutex](arc-and-mutex.md) diff --git a/README.md b/src/README.md similarity index 99% rename from README.md rename to src/README.md index b2e1eac..d577d7b 100644 --- a/README.md +++ b/src/README.md @@ -1,4 +1,4 @@ -% The Rustonomicon +# The Rustonomicon #### The Dark Arts of Advanced and Unsafe Rust Programming diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 7390c82..e33dcbb 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,3 +1,55 @@ # Summary -- [Chapter 1](./chapter_1.md) +[Introduction](README.md) + +* [Meet Safe and Unsafe](meet-safe-and-unsafe.md) + * [How Safe and Unsafe Interact](safe-unsafe-meaning.md) + * [Working with Unsafe](working-with-unsafe.md) +* [Data Layout](data.md) + * [repr(Rust)](repr-rust.md) + * [Exotically Sized Types](exotic-sizes.md) + * [Other reprs](other-reprs.md) +* [Ownership](ownership.md) + * [References](references.md) + * [Lifetimes](lifetimes.md) + * [Limits of Lifetimes](lifetime-mismatch.md) + * [Lifetime Elision](lifetime-elision.md) + * [Unbounded Lifetimes](unbounded-lifetimes.md) + * [Higher-Rank Trait Bounds](hrtb.md) + * [Subtyping and Variance](subtyping.md) + * [Drop Check](dropck.md) + * [PhantomData](phantom-data.md) + * [Splitting Borrows](borrow-splitting.md) +* [Type Conversions](conversions.md) + * [Coercions](coercions.md) + * [The Dot Operator](dot-operator.md) + * [Casts](casts.md) + * [Transmutes](transmutes.md) +* [Uninitialized Memory](uninitialized.md) + * [Checked](checked-uninit.md) + * [Drop Flags](drop-flags.md) + * [Unchecked](unchecked-uninit.md) +* [Ownership Based Resource Management](obrm.md) + * [Constructors](constructors.md) + * [Destructors](destructors.md) + * [Leaking](leaking.md) +* [Unwinding](unwinding.md) + * [Exception Safety](exception-safety.md) + * [Poisoning](poisoning.md) +* [Concurrency](concurrency.md) + * [Races](races.md) + * [Send and Sync](send-and-sync.md) + * [Atomics](atomics.md) +* [Implementing Vec](vec.md) + * [Layout](vec-layout.md) + * [Allocating](vec-alloc.md) + * [Push and Pop](vec-push-pop.md) + * [Deallocating](vec-dealloc.md) + * [Deref](vec-deref.md) + * [Insert and Remove](vec-insert-remove.md) + * [IntoIter](vec-into-iter.md) + * [RawVec](vec-raw.md) + * [Drain](vec-drain.md) + * [Handling Zero-Sized Types](vec-zsts.md) + * [Final Code](vec-final.md) +* [Implementing Arc and Mutex](arc-and-mutex.md) diff --git a/arc-and-mutex.md b/src/arc-and-mutex.md similarity index 89% rename from arc-and-mutex.md rename to src/arc-and-mutex.md index fcafe55..fedc7b8 100644 --- a/arc-and-mutex.md +++ b/src/arc-and-mutex.md @@ -1,4 +1,4 @@ -% Implementing Arc and Mutex +# Implementing Arc and Mutex Knowing the theory is all fine and good, but the *best* way to understand something is to use it. To better understand atomics and interior mutability, diff --git a/atomics.md b/src/atomics.md similarity index 99% rename from atomics.md rename to src/atomics.md index 7b4c44f..e9ed21a 100644 --- a/atomics.md +++ b/src/atomics.md @@ -1,4 +1,4 @@ -% Atomics +# Atomics Rust pretty blatantly just inherits C11's memory model for atomics. This is not due to this model being particularly excellent or easy to understand. Indeed, diff --git a/borrow-splitting.md b/src/borrow-splitting.md similarity index 99% rename from borrow-splitting.md rename to src/borrow-splitting.md index cc5bc8a..28ddb50 100644 --- a/borrow-splitting.md +++ b/src/borrow-splitting.md @@ -1,4 +1,4 @@ -% Splitting Borrows +# Splitting Borrows The mutual exclusion property of mutable references can be very limiting when working with a composite structure. The borrow checker understands some basic diff --git a/casts.md b/src/casts.md similarity index 99% rename from casts.md rename to src/casts.md index 6cc41bd..31b7858 100644 --- a/casts.md +++ b/src/casts.md @@ -1,4 +1,4 @@ -% Casts +# Casts Casts are a superset of coercions: every coercion can be explicitly invoked via a cast. However some conversions require a cast. diff --git a/checked-uninit.md b/src/checked-uninit.md similarity index 98% rename from checked-uninit.md rename to src/checked-uninit.md index f7c4482..4423404 100644 --- a/checked-uninit.md +++ b/src/checked-uninit.md @@ -1,4 +1,4 @@ -% Checked Uninitialized Memory +# Checked Uninitialized Memory Like C, all stack variables in Rust are uninitialized until a value is explicitly assigned to them. Unlike C, Rust statically prevents you from ever diff --git a/coercions.md b/src/coercions.md similarity index 99% rename from coercions.md rename to src/coercions.md index b699946..1a51bb5 100644 --- a/coercions.md +++ b/src/coercions.md @@ -1,4 +1,4 @@ -% Coercions +# Coercions Types can implicitly be coerced to change in certain contexts. These changes are generally just *weakening* of types, largely focused around pointers and diff --git a/concurrency.md b/src/concurrency.md similarity index 96% rename from concurrency.md rename to src/concurrency.md index b93b303..6205199 100644 --- a/concurrency.md +++ b/src/concurrency.md @@ -1,4 +1,4 @@ -% Concurrency and Parallelism +# Concurrency and Parallelism Rust as a language doesn't *really* have an opinion on how to do concurrency or parallelism. The standard library exposes OS threads and blocking sys-calls diff --git a/constructors.md b/src/constructors.md similarity index 99% rename from constructors.md rename to src/constructors.md index 97817cd..b79e72d 100644 --- a/constructors.md +++ b/src/constructors.md @@ -1,4 +1,4 @@ -% Constructors +# Constructors There is exactly one way to create an instance of a user-defined type: name it, and initialize all its fields at once: diff --git a/conversions.md b/src/conversions.md similarity index 98% rename from conversions.md rename to src/conversions.md index b099a78..388d003 100644 --- a/conversions.md +++ b/src/conversions.md @@ -1,4 +1,4 @@ -% Type Conversions +# Type Conversions At the end of the day, everything is just a pile of bits somewhere, and type systems are just there to help us use those bits right. There are two common diff --git a/data.md b/src/data.md similarity index 87% rename from data.md rename to src/data.md index d0a796b..bf202ad 100644 --- a/data.md +++ b/src/data.md @@ -1,4 +1,4 @@ -% Data Representation in Rust +# Data Representation in Rust Low-level programming cares a lot about data layout. It's a big deal. It also pervasively influences the rest of the language, so we're going to start by diff --git a/destructors.md b/src/destructors.md similarity index 99% rename from destructors.md rename to src/destructors.md index be4730c..8c395fe 100644 --- a/destructors.md +++ b/src/destructors.md @@ -1,4 +1,4 @@ -% Destructors +# Destructors What the language *does* provide is full-blown automatic destructors through the `Drop` trait, which provides the following method: diff --git a/dot-operator.md b/src/dot-operator.md similarity index 93% rename from dot-operator.md rename to src/dot-operator.md index 5d2010d..a1fc33b 100644 --- a/dot-operator.md +++ b/src/dot-operator.md @@ -1,4 +1,4 @@ -% The Dot Operator +# The Dot Operator The dot operator will perform a lot of magic to convert types. It will perform auto-referencing, auto-dereferencing, and coercion until types match. diff --git a/drop-flags.md b/src/drop-flags.md similarity index 99% rename from drop-flags.md rename to src/drop-flags.md index cfceafe..51fa9d0 100644 --- a/drop-flags.md +++ b/src/drop-flags.md @@ -1,4 +1,4 @@ -% Drop Flags +# Drop Flags The examples in the previous section introduce an interesting problem for Rust. We have seen that it's possible to conditionally initialize, deinitialize, and diff --git a/dropck.md b/src/dropck.md similarity index 99% rename from dropck.md rename to src/dropck.md index 6114006..3903969 100644 --- a/dropck.md +++ b/src/dropck.md @@ -1,4 +1,4 @@ -% Drop Check +# Drop Check We have seen how lifetimes provide us some fairly simple rules for ensuring that we never read dangling references. However up to this point we have only ever diff --git a/exception-safety.md b/src/exception-safety.md similarity index 99% rename from exception-safety.md rename to src/exception-safety.md index 74f7831..80e72cd 100644 --- a/exception-safety.md +++ b/src/exception-safety.md @@ -1,4 +1,4 @@ -% Exception Safety +# Exception Safety Although programs should use unwinding sparingly, there's a lot of code that *can* panic. If you unwrap a None, index out of bounds, or divide by 0, your diff --git a/exotic-sizes.md b/src/exotic-sizes.md similarity index 99% rename from exotic-sizes.md rename to src/exotic-sizes.md index 052e3c5..9f858d1 100644 --- a/exotic-sizes.md +++ b/src/exotic-sizes.md @@ -1,4 +1,4 @@ -% Exotically Sized Types +# Exotically Sized Types Most of the time, we think in terms of types with a fixed, positive size. This is not always the case, however. diff --git a/hrtb.md b/src/hrtb.md similarity index 98% rename from hrtb.md rename to src/hrtb.md index 8692832..645986a 100644 --- a/hrtb.md +++ b/src/hrtb.md @@ -1,4 +1,4 @@ -% Higher-Rank Trait Bounds (HRTBs) +# Higher-Rank Trait Bounds (HRTBs) Rust's `Fn` traits are a little bit magic. For instance, we can write the following code: diff --git a/leaking.md b/src/leaking.md similarity index 99% rename from leaking.md rename to src/leaking.md index a5d5742..38b70b8 100644 --- a/leaking.md +++ b/src/leaking.md @@ -1,4 +1,4 @@ -% Leaking +# Leaking Ownership-based resource management is intended to simplify composition. You acquire resources when you create the object, and you release the resources when diff --git a/lifetime-elision.md b/src/lifetime-elision.md similarity index 99% rename from lifetime-elision.md rename to src/lifetime-elision.md index bcd93a5..e92d735 100644 --- a/lifetime-elision.md +++ b/src/lifetime-elision.md @@ -1,4 +1,4 @@ -% Lifetime Elision +# Lifetime Elision In order to make common patterns more ergonomic, Rust allows lifetimes to be *elided* in function signatures. diff --git a/lifetime-mismatch.md b/src/lifetime-mismatch.md similarity index 98% rename from lifetime-mismatch.md rename to src/lifetime-mismatch.md index 0ad8a78..30b4f09 100644 --- a/lifetime-mismatch.md +++ b/src/lifetime-mismatch.md @@ -1,4 +1,4 @@ -% Limits of Lifetimes +# Limits of Lifetimes Given the following code: diff --git a/lifetimes.md b/src/lifetimes.md similarity index 99% rename from lifetimes.md rename to src/lifetimes.md index 45eb68b..e2f0cc8 100644 --- a/lifetimes.md +++ b/src/lifetimes.md @@ -1,4 +1,4 @@ -% Lifetimes +# Lifetimes Rust enforces these rules through *lifetimes*. Lifetimes are effectively just names for scopes somewhere in the program. Each reference, diff --git a/meet-safe-and-unsafe.md b/src/meet-safe-and-unsafe.md similarity index 99% rename from meet-safe-and-unsafe.md rename to src/meet-safe-and-unsafe.md index 15d84fd..d42d0b6 100644 --- a/meet-safe-and-unsafe.md +++ b/src/meet-safe-and-unsafe.md @@ -1,4 +1,4 @@ -% Meet Safe and Unsafe +# Meet Safe and Unsafe Programmers in safe "high-level" languages face a fundamental dilemma. On one hand, it would be *really* great to just say what you want and not worry about diff --git a/obrm.md b/src/obrm.md similarity index 93% rename from obrm.md rename to src/obrm.md index 2c49524..19e5ec3 100644 --- a/obrm.md +++ b/src/obrm.md @@ -1,4 +1,4 @@ -% The Perils Of Ownership Based Resource Management (OBRM) +# The Perils Of Ownership Based Resource Management (OBRM) OBRM (AKA RAII: Resource Acquisition Is Initialization) is something you'll interact with a lot in Rust. Especially if you use the standard library. diff --git a/other-reprs.md b/src/other-reprs.md similarity index 99% rename from other-reprs.md rename to src/other-reprs.md index b124f3f..02f39e3 100644 --- a/other-reprs.md +++ b/src/other-reprs.md @@ -1,4 +1,4 @@ -% Alternative representations +# Alternative representations Rust allows you to specify alternative data layout strategies from the default. diff --git a/ownership.md b/src/ownership.md similarity index 99% rename from ownership.md rename to src/ownership.md index a6ecf6a..dd9e9db 100644 --- a/ownership.md +++ b/src/ownership.md @@ -1,4 +1,4 @@ -% Ownership and Lifetimes +# Ownership and Lifetimes Ownership is the breakout feature of Rust. It allows Rust to be completely memory-safe and efficient, while avoiding garbage collection. Before getting diff --git a/phantom-data.md b/src/phantom-data.md similarity index 99% rename from phantom-data.md rename to src/phantom-data.md index 1896957..72fa2e2 100644 --- a/phantom-data.md +++ b/src/phantom-data.md @@ -1,4 +1,4 @@ -% PhantomData +# PhantomData When working with unsafe code, we can often end up in a situation where types or lifetimes are logically associated with a struct, but not actually diff --git a/poisoning.md b/src/poisoning.md similarity index 99% rename from poisoning.md rename to src/poisoning.md index 70de91a..9b5dec3 100644 --- a/poisoning.md +++ b/src/poisoning.md @@ -1,4 +1,4 @@ -% Poisoning +# Poisoning Although all unsafe code *must* ensure it has minimal exception safety, not all types ensure *maximal* exception safety. Even if the type does, your code may diff --git a/races.md b/src/races.md similarity index 99% rename from races.md rename to src/races.md index 5145987..c9b8c3d 100644 --- a/races.md +++ b/src/races.md @@ -1,4 +1,4 @@ -% Data Races and Race Conditions +# Data Races and Race Conditions Safe Rust guarantees an absence of data races, which are defined as: diff --git a/references.md b/src/references.md similarity index 99% rename from references.md rename to src/references.md index 3d7369e..5d80f1e 100644 --- a/references.md +++ b/src/references.md @@ -1,4 +1,4 @@ -% References +# References This section gives a high-level view of the memory model that *all* Rust programs must satisfy to be correct. Safe code is statically verified diff --git a/repr-rust.md b/src/repr-rust.md similarity index 99% rename from repr-rust.md rename to src/repr-rust.md index effeaf8..c02cf44 100644 --- a/repr-rust.md +++ b/src/repr-rust.md @@ -1,4 +1,4 @@ -% repr(Rust) +# repr(Rust) First and foremost, all types have an alignment specified in bytes. The alignment of a type specifies what addresses are valid to store the value at. A diff --git a/safe-unsafe-meaning.md b/src/safe-unsafe-meaning.md similarity index 99% rename from safe-unsafe-meaning.md rename to src/safe-unsafe-meaning.md index adede0e..0a655a3 100644 --- a/safe-unsafe-meaning.md +++ b/src/safe-unsafe-meaning.md @@ -1,4 +1,4 @@ -% How Safe and Unsafe Interact +# How Safe and Unsafe Interact What's the relationship between Safe Rust and Unsafe Rust? How do they interact? diff --git a/send-and-sync.md b/src/send-and-sync.md similarity index 99% rename from send-and-sync.md rename to src/send-and-sync.md index 134e47f..959f870 100644 --- a/send-and-sync.md +++ b/src/send-and-sync.md @@ -1,4 +1,4 @@ -% Send and Sync +# Send and Sync Not everything obeys inherited mutability, though. Some types allow you to multiply alias a location in memory while mutating it. Unless these types use diff --git a/subtyping.md b/src/subtyping.md similarity index 99% rename from subtyping.md rename to src/subtyping.md index eb940e8..d771712 100644 --- a/subtyping.md +++ b/src/subtyping.md @@ -1,4 +1,4 @@ -% Subtyping and Variance +# Subtyping and Variance Although Rust doesn't have any notion of structural inheritance, it *does* include subtyping. In Rust, subtyping derives entirely from lifetimes. Since diff --git a/transmutes.md b/src/transmutes.md similarity index 99% rename from transmutes.md rename to src/transmutes.md index f1478b7..043c8fe 100644 --- a/transmutes.md +++ b/src/transmutes.md @@ -1,4 +1,4 @@ -% Transmutes +# Transmutes Get out of our way type system! We're going to reinterpret these bits or die trying! Even though this book is all about doing things that are unsafe, I diff --git a/unbounded-lifetimes.md b/src/unbounded-lifetimes.md similarity index 98% rename from unbounded-lifetimes.md rename to src/unbounded-lifetimes.md index 1f3693f..b41cf8b 100644 --- a/unbounded-lifetimes.md +++ b/src/unbounded-lifetimes.md @@ -1,4 +1,4 @@ -% Unbounded Lifetimes +# Unbounded Lifetimes Unsafe code can often end up producing references or lifetimes out of thin air. Such lifetimes come into the world as *unbounded*. The most common source of this diff --git a/unchecked-uninit.md b/src/unchecked-uninit.md similarity index 99% rename from unchecked-uninit.md rename to src/unchecked-uninit.md index c72ed8a..ef31a35 100644 --- a/unchecked-uninit.md +++ b/src/unchecked-uninit.md @@ -1,4 +1,4 @@ -% Unchecked Uninitialized Memory +# Unchecked Uninitialized Memory One interesting exception to this rule is working with arrays. Safe Rust doesn't permit you to partially initialize an array. When you initialize an array, you diff --git a/uninitialized.md b/src/uninitialized.md similarity index 93% rename from uninitialized.md rename to src/uninitialized.md index 05615d8..eafc679 100644 --- a/uninitialized.md +++ b/src/uninitialized.md @@ -1,4 +1,4 @@ -% Working With Uninitialized Memory +# Working With Uninitialized Memory All runtime-allocated memory in a Rust program begins its life as *uninitialized*. In this state the value of the memory is an indeterminate pile diff --git a/unwinding.md b/src/unwinding.md similarity index 99% rename from unwinding.md rename to src/unwinding.md index e81f06b..6dc396d 100644 --- a/unwinding.md +++ b/src/unwinding.md @@ -1,4 +1,4 @@ -% Unwinding +# Unwinding Rust has a *tiered* error-handling scheme: diff --git a/vec-alloc.md b/src/vec-alloc.md similarity index 99% rename from vec-alloc.md rename to src/vec-alloc.md index bc60a57..ef4c527 100644 --- a/vec-alloc.md +++ b/src/vec-alloc.md @@ -1,4 +1,4 @@ -% Allocating Memory +# Allocating Memory Using Unique throws a wrench in an important feature of Vec (and indeed all of the std collections): an empty Vec doesn't actually allocate at all. So if we diff --git a/vec-dealloc.md b/src/vec-dealloc.md similarity index 98% rename from vec-dealloc.md rename to src/vec-dealloc.md index 706fe68..83ab5b2 100644 --- a/vec-dealloc.md +++ b/src/vec-dealloc.md @@ -1,4 +1,4 @@ -% Deallocating +# Deallocating Next we should implement Drop so that we don't massively leak tons of resources. The easiest way is to just call `pop` until it yields None, and then deallocate diff --git a/vec-deref.md b/src/vec-deref.md similarity index 99% rename from vec-deref.md rename to src/vec-deref.md index 6460eab..e21542c 100644 --- a/vec-deref.md +++ b/src/vec-deref.md @@ -1,4 +1,4 @@ -% Deref +# Deref Alright! We've got a decent minimal stack implemented. We can push, we can pop, and we can clean up after ourselves. However there's a whole mess of diff --git a/vec-drain.md b/src/vec-drain.md similarity index 99% rename from vec-drain.md rename to src/vec-drain.md index 6e732ee..5bd2bf0 100644 --- a/vec-drain.md +++ b/src/vec-drain.md @@ -1,4 +1,4 @@ -% Drain +# Drain Let's move on to Drain. Drain is largely the same as IntoIter, except that instead of consuming the Vec, it borrows the Vec and leaves its allocation diff --git a/vec-final.md b/src/vec-final.md similarity index 99% rename from vec-final.md rename to src/vec-final.md index 1f4377a..39746ca 100644 --- a/vec-final.md +++ b/src/vec-final.md @@ -1,4 +1,4 @@ -% The Final Code +# The Final Code ```rust #![feature(unique)] diff --git a/vec-insert-remove.md b/src/vec-insert-remove.md similarity index 98% rename from vec-insert-remove.md rename to src/vec-insert-remove.md index bcecd78..2c14bc4 100644 --- a/vec-insert-remove.md +++ b/src/vec-insert-remove.md @@ -1,4 +1,4 @@ -% Insert and Remove +# Insert and Remove Something *not* provided by slice is `insert` and `remove`, so let's do those next. diff --git a/vec-into-iter.md b/src/vec-into-iter.md similarity index 99% rename from vec-into-iter.md rename to src/vec-into-iter.md index ebb0a79..f2f5995 100644 --- a/vec-into-iter.md +++ b/src/vec-into-iter.md @@ -1,4 +1,4 @@ -% IntoIter +# IntoIter Let's move on to writing iterators. `iter` and `iter_mut` have already been written for us thanks to The Magic of Deref. However there's two interesting diff --git a/vec-layout.md b/src/vec-layout.md similarity index 99% rename from vec-layout.md rename to src/vec-layout.md index 7ca369d..1dc09ae 100644 --- a/vec-layout.md +++ b/src/vec-layout.md @@ -1,4 +1,4 @@ -% Layout +# Layout First off, we need to come up with the struct layout. A Vec has three parts: a pointer to the allocation, the size of the allocation, and the number of diff --git a/vec-push-pop.md b/src/vec-push-pop.md similarity index 99% rename from vec-push-pop.md rename to src/vec-push-pop.md index 5e747a8..d31a74c 100644 --- a/vec-push-pop.md +++ b/src/vec-push-pop.md @@ -1,4 +1,4 @@ -% Push and Pop +# Push and Pop Alright. We can initialize. We can allocate. Let's actually implement some functionality! Let's start with `push`. All it needs to do is check if we're diff --git a/vec-raw.md b/src/vec-raw.md similarity index 99% rename from vec-raw.md rename to src/vec-raw.md index 8f78462..20fa8ab 100644 --- a/vec-raw.md +++ b/src/vec-raw.md @@ -1,4 +1,4 @@ -% RawVec +# RawVec We've actually reached an interesting situation here: we've duplicated the logic for specifying a buffer and freeing its memory in Vec and IntoIter. Now that diff --git a/vec-zsts.md b/src/vec-zsts.md similarity index 99% rename from vec-zsts.md rename to src/vec-zsts.md index 5f3b2a8..5ae9bdd 100644 --- a/vec-zsts.md +++ b/src/vec-zsts.md @@ -1,4 +1,4 @@ -% Handling Zero-Sized Types +# Handling Zero-Sized Types It's time. We're going to fight the specter that is zero-sized types. Safe Rust *never* needs to care about this, but Vec is very intensive on raw pointers and diff --git a/vec.md b/src/vec.md similarity index 97% rename from vec.md rename to src/vec.md index 6913019..ad98e45 100644 --- a/vec.md +++ b/src/vec.md @@ -1,4 +1,4 @@ -% Example: Implementing Vec +# Example: Implementing Vec To bring everything together, we're going to write `std::Vec` from scratch. Because all the best tools for writing unsafe code are unstable, this diff --git a/working-with-unsafe.md b/src/working-with-unsafe.md similarity index 99% rename from working-with-unsafe.md rename to src/working-with-unsafe.md index b20dff7..5724f3d 100644 --- a/working-with-unsafe.md +++ b/src/working-with-unsafe.md @@ -1,4 +1,4 @@ -% Working with Unsafe +# Working with Unsafe Rust generally only gives us the tools to talk about Unsafe Rust in a scoped and binary manner. Unfortunately, reality is significantly more complicated than