Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Allocator-api2 #21

Merged
3 commits merged into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Rust

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose

miri:
name: "Miri"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Miri
run: |
rustup toolchain install nightly --component miri
rustup override set nightly
cargo miri setup
- name: Test with Miri
run: MIRIFLAGS=-Zmiri-strict-provenance cargo miri test

fmt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: rustfmt
- run: cargo fmt --all -- --check


clippy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: clippy
- run: cargo clippy --workspace --tests --examples


docs:
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: -Dwarnings
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- uses: swatinem/rust-cache@v2
- run: cargo doc --workspace --no-deps

msrv:
name: Rust ${{matrix.rust}}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
rust: [1.56.0, 1.57.0]
timeout-minutes: 45
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{matrix.rust}}
- run: cargo test --verbose
18 changes: 0 additions & 18 deletions .travis.yml

This file was deleted.

11 changes: 7 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,21 @@

name = "linked-list"
version = "0.0.3"
license = "MIT/Apache-2.0"
license = "MIT OR Apache-2.0"
description = "An alternative implementation of std::collections::LinkedList"

authors = [
"Alexis Beingessner <[email protected]>",
"Peter Blackson <[email protected]>",
]

edition = "2021"

repository = "https://github.com/contain-rs/linked-list"
homepage = "https://github.com/contain-rs/linked-list"
documentation = "https://contain-rs.github.io/linked-list/linked_list"
documentation = "https://docs.rs/linked-list/latest/linked_list"
keywords = ["data-structures"]
readme = "README.md"

[features]
nightly = []
[dependencies]
allocator-api2 = "0.2.20"
2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015 The Rust Project Developers
Copyright (c) 2015-2024 The Rust Project Developers

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
Expand Down
69 changes: 67 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,68 @@
An alternative implementation of `std::collections::LinkedList` featuring a prototype Cursor.
<div align="center">
<h1>linked-list</h1>
<p>
<strong>A compact vector of bits.</strong>
</p>
<p>

Documentation is available at https://contain-rs.github.io/linked-list/linked_list.
[![crates.io][crates.io shield]][crates.io link]
[![Documentation][docs.rs badge]][docs.rs link]
![Rust CI][github ci badge]
![Minimum Supported Rustc Version][rustc 1.56+]
[![serde_derive: rustc 1.31+]][Rust 1.31]
<br />
<br />
[![Dependency Status][deps.rs status]][deps.rs link]
[![Download Status][shields.io download count]][crates.io link]

</p>
</div>

[crates.io shield]: https://img.shields.io/crates/v/linked-list?label=latest
[crates.io link]: https://crates.io/crates/linked-list
[docs.rs badge]: https://docs.rs/linked-list/badge.svg?version=0.0.3
[docs.rs link]: https://docs.rs/linked-list/0.0.3/linked_list/
[github ci badge]: https://github.com/contain-rs/linked-list/workflows/Rust/badge.svg?branch=master
[rustc 1.56+]: https://img.shields.io/badge/rustc-1.56%2B-blue.svg
[serde_derive: rustc 1.31+]: https://img.shields.io/badge/serde_derive-rustc_1.31+-lightgray.svg
[deps.rs status]: https://deps.rs/crate/linked-list/0.0.3/status.svg
[deps.rs link]: https://deps.rs/crate/linked-list/0.0.3
[shields.io download count]: https://img.shields.io/crates/d/linked-list.svg

## Usage

Add this to your Cargo.toml:

```toml
[dependencies]
linked-list = "0.0.3"
```

Since Rust 2018, `extern crate` is no longer mandatory. If your edition is old (Rust 2015),
add this to your crate root:

```rust
extern crate linked_list;
```

If you want [serde](https://github.com/serde-rs/serde) support, include the feature like this:

```toml
[dependencies]
linked-list = { version = "0.0.3", features = ["serde"] }
```

<!-- cargo-rdme start -->

### Description

An alternative implementation of standard `LinkedList` featuring a prototype `Cursor`.

<!-- cargo-rdme end -->

## License

Dual-licensed for compatibility with the Rust project.

Licensed under the Apache License Version 2.0: http://www.apache.org/licenses/LICENSE-2.0,
or the MIT license: http://opensource.org/licenses/MIT, at your option.
20 changes: 0 additions & 20 deletions deploy-docs.sh

This file was deleted.

Loading
Loading