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: SELECT
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
30101427362 feat/generator-safe-idents Merge 52d48254b into 4f73812d6 Pull #152 web-flow github
54.67
30100250885 feat/methodcall-push-fd Merge 0aa089bbb into 4f73812d6 Pull #149 web-flow github
56.31
30052262086 clippy chore: cargo clippy and fmt and nix flake update Pull #151 haraldh github
54.62
30052264835 clippy Merge d2adf94cb into b733583c9 Pull #151 web-flow github
54.62
30052209412 clippy chore: cargo clippy push haraldh github
54.63
30052211486 clippy Merge cc3120530 into b733583c9 Pull #151 web-flow github
54.63
30051894608 clippy chore: cargo clippy Pull #151 haraldh github
54.63
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
30051742848 RaitoBezarius/master chore: cargo clippy push haraldh github
54.63
See All Builds (343)