varlink / rust
56%

DEFAULT BRANCH: master
Repo Added
Files 27
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH master
branch: master
CHANGE BRANCH
x

coverage: 56.305% (+1.7%) from 54.632%
30166081117

push

github

web-flow 
feat: add MethodCall::push_fd() for passing file descriptors (SCM_RIGHTS) (#149)

systemd's `sd-varlink` extends varlink with file-descriptor passing over
the
Unix socket via SCM_RIGHTS: fds are pushed before the call and
referenced from
the parameters by their push-order index. (This is not part of the core
varlink
protocol as specified on varlink.org — the push-order convention is the
de-facto
one used by systemd's services.) This crate had no client-side way to
attach
fds; this adds that, mirroring `sd_varlink_push_fd()`.

## API

```rust
let mut call = client.some_method(args);
let idx = call.push_fd(fd)?;   // -> 0, then 1, ... (push order == the index methods reference)
call.more()?;                  // or .call()/.oneway(); fds are delivered with the request
```

- `MethodCall::push_fd(fd) -> io::Result<usize>` (unix only). Dups the
fd with
`F_DUPFD_CLOEXEC` (caller keeps ownership of the original), queues it,
and
  returns its push-order index.
- On send, queued fds are delivered with the request via a single
`sendmsg()` + `SCM_RIGHTS` on the connection's socket; any bytes past
the first
  `sendmsg` are written normally through the existing writer.
- Only `AF_UNIX`-socket-backed connections support this — SCM_RIGHTS
does not
exist elsewhere. `push_fd` checks the socket family up front
(`getsockname`),
so a `tcp:` connection or a reader/writer-pair connection fails
immediately
  with `io::ErrorKind::Unsupported` rather than later at send time.

No opt-in gate (cf. systemd's
`SD_VARLINK_SERVER_ALLOW_FD_PASSING_OUTPUT`):
on the client side, calling `push_fd` is itself the explicit opt-in — no
ancillary data is ever attached unless the application pushed an fd for
that
specific call.

## Scope

Send-only. Receiving descriptors (server → client) is not implemented —
it would
require recvmsg-based reading throughout the input path, and nothing
needs it yet.
`cfg(unix)` only, matching the crate's existing platform split; `libc`
is already
a unix depe... (continued)

222 of 226 new or added lines in 2 files covered. (98.23%)

64 existing lines in 2 files now uncovered.

3045 of 5408 relevant lines covered (56.31%)

13.6 hits per line

Relevant lines Covered
5408 RELEVANT LINES 3045 COVERED LINES
13.6 HITS PER LINE
Source Files on master

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
30166081117 master feat: add MethodCall::push_fd() for passing file descriptors (SCM_RIGHTS) (#149) systemd's `sd-varlink` extends varlink with file-descriptor passing over the Unix socket via SCM_RIGHTS: fds are pushed before the call and referenced from the param... push web-flow github
56.31
30051844958 master feat: Expose some functions for async users who accepts the connection themselves (#147) Fixes #146. The rationale is described in commit messages but it boils down to: it's very hard to accept connections yourselves and reuse these logic. push web-flow github
54.63
20912542228 master fix: add --all-features to coverage and lint workflows (#144) The coverage and clippy workflows were not testing async code because they ran without --all-features. The tokio feature enables async support in the varlink crate, so without it: - Co... push web-flow github
54.42
20912073532 master chore: replace deprecated `tempdir` crate with `tempfile` (#142) The `tempdir` crate has been deprecated in favor of `tempfile`, which now provides all the same functionality. This migration updates varlink_generator's test dependencies to use `t... push web-flow github
54.42
20911859055 master build(deps): bump quote from 1.0.41 to 1.0.42 (#137) Bumps [quote](https://github.com/dtolnay/quote) from 1.0.41 to 1.0.42. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/dtolnay/quote/releases">quote's... push web-flow github
54.42
20879375911 master feat: add socket activation and bridge support for AsyncConnection (#143) ## Summary - Add `AsyncConnection::with_activate()` for systemd-style socket activation - spawns a server subprocess with `LISTEN_FDS`, `LISTEN_PID`, and `LISTEN_FDNAMES` ... push web-flow github
54.42
20877281246 master feat: add multi-reply support for async mode (more/continues flags) (#141) The `more` flag in requests and `continues` flag in responses were not working in async mode. This commit fixes the async code generation and client to properly support mu... push web-flow github
54.0
20335336910 master feat: add AsyncVarlinkService for async introspection support (#139) Add introspection support (GetInfo, GetInterfaceDescription) for async varlink services, addressing issue #138. Changes: - Add AsyncInterface trait extending AsyncConnectionHan... push web-flow github
53.75
18943125814 master chore: update `peg` to v0.8.5 and adjust interface parsing logic (#132) refactor `ParseInterface` function and test cases to include `full_input` parameter for improved parsing. push web-flow github
55.63
18656814287 master chore: update `clap` to v4.5.49 and integrate `clap_complete` (#131) (#131) refactor CLI structure to leverage updated `clap` APIs and implement shell completions generation. push web-flow github
55.3
See All Builds (343)