mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-07-02 19:21:37 +00:00

Go to file

Thomas Eizinger c1ef4bffd2 core/: Redesign upgrade::{write_one, write_with_len_prefix, read_one} (#2111 )

1. Deprecating the `write_one` function

  Semantically, this function is a composition of `write_with_len_prefix` and
  `io.close()`. This represents a footgun because the `close` functionality is
  not obvious and only mentioned in the docs. Using this function multiple times
  on a single substream will produces hard to debug behaviour.

2. Deprecating `read_one` and `write_with_len_prefix` functions

3. Introducing `write_length_prefixed` and `read_length_prefixed`

- These functions are symmetric and do exactly what you would expect, just
  writing to the socket without closing
- They also have a symmetric interface (no more custom errors, just `io::Error`)

Co-authored-by: Max Inden <mail@max-inden.de>

2021-07-03 16:23:10 +02:00

.github

build(deps): Bump actions/cache from 2.1.5 to 2.1.6 (#2084 )

2021-05-28 11:43:43 +02:00

core

core/: Redesign upgrade::{write_one, write_with_len_prefix, read_one} (#2111 )

2021-07-03 16:23:10 +02:00

docs

docs/release: Only choose crate name not bench name (#1897 )

2020-12-18 11:35:39 +01:00

examples

protocols/kad: Extend emitted events with basic information (#2087 )

2021-06-28 14:14:31 +02:00

misc

*: Use upstream multiaddr crate (#2075 )

2021-05-27 14:04:33 +02:00

muxers

muxers/mplex: Allow up to 60 bit long stream IDs (#2094 )

2021-06-28 17:47:59 +02:00

protocols

core/: Redesign upgrade::{write_one, write_with_len_prefix, read_one} (#2111 )

2021-07-03 16:23:10 +02:00

src

swarm/: Drive ExpandedSwarm via Stream trait only (#2100 )

2021-06-14 20:41:44 +02:00

swarm

swarm/: Allow disconnecting from Swarm and NetworkBehaviour (#2110 )

2021-07-02 19:35:51 +02:00

swarm-derive

swarm/: Allow disconnecting from Swarm and NetworkBehaviour (#2110 )

2021-07-02 19:35:51 +02:00

transports

transports/dns: Document caveats of using the trust-dns-resolver crate (#2114 )

2021-06-30 21:02:20 +02:00

.editorconfig

Update .editorconfig to align with rustfmt. (#162 )

2018-04-09 10:52:25 +02:00

.gitignore

initial commit: transport interfaces

2017-04-08 03:31:22 +02:00

Cargo.toml

*: Use upstream multiaddr crate (#2075 )

2021-05-27 14:04:33 +02:00

CHANGELOG.md

*: Use upstream multiaddr crate (#2075 )

2021-05-27 14:04:33 +02:00

LICENSE

Some petty changes head of QUIC (#1854 )

2020-11-24 12:40:11 +01:00

README.md

README: Remove freenode IRC link (#2096 )

2021-06-11 14:21:37 +02:00

README.md

Central repository for work on libp2p

This repository is the central place for Rust development of the libp2p spec.

Getting started

Main documentation can be found on https://docs.rs/libp2p.
The examples folder contains small binaries showcasing the many protocols in this repository.
To report bugs, suggest improvements or request new features please open GitHub issue on this repository.
For rust-libp2p specific questions please use the GitHub Discussions forum https://github.com/libp2p/rust-libp2p/discussions.
For discussions and questions related to multiple libp2p implementations please use the libp2p Discourse forum https://discuss.libp2p.io.

Repository Structure

The main components of this repository are structured as follows:

core/: The implementation of libp2p-core with its Network, Transport and StreamMuxer API on which almost all other crates depend.
transports/: Implementations of transport protocols (e.g. TCP) and protocol upgrades (e.g. for authenticated encryption, compression, ...) based on the libp2p-core Transport API .
muxers/: Implementations of the StreamMuxer interface of libp2p-core, e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections. Multiplexing protocols are (mandatory) Transport upgrades.
swarm/: The implementation of libp2p-swarm building on libp2p-core with the central interfaces NetworkBehaviour and ProtocolsHandler used to implement application protocols (see protocols/).
protocols/: Implementations of application protocols based on the libp2p-swarm APIs.
misc/: Utility libraries.
examples/: Worked examples of built-in application protocols (see protocols/) with common Transport configurations.

Community Guidelines

The libp2p project operates under the IPFS Code of Conduct.

tl;dr

Be respectful.

We're here to help: abuse@ipfs.io

Abusive behavior is never tolerated.

Violations of this code may result in swift and permanent expulsion from the IPFS [and libp2p] community.

"Too long, didn't read" is not a valid excuse for not knowing what is in this document.

Notable users

(open a pull request if you want your project to be added here)