zlink 0.4.1

Async Varlink API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# Examples

This directory contains examples demonstrating the usage of the zlink library.

## varlink-inspect

A CLI tool for inspecting Varlink services via Unix domain sockets.

### Description

The `varlink-inspect` example demonstrates how to use the `varlink_service::Proxy` trait to
introspect Varlink services. It connects to a Unix domain socket, retrieves service information,
and optionally provides detailed interface descriptions with parsed IDL information.

### Basic Usage

```bash
# Show service information and available interfaces
cargo run --example varlink-inspect --features="introspection idl-parse" --
/run/systemd/machine/io.systemd.Machine

# Get detailed interface description with methods, types, and documentation
cargo run --example varlink-inspect --features="introspection idl-parse" --
/run/systemd/machine/io.systemd.Machine io.systemd.Machine
```

### Example Output

When inspecting the systemd machine interface, you'll see:

```
🔍 Service Information
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  Vendor:     The systemd Project
  Product:    systemd (systemd-machined)
  Version:    257.5 (257.5-6.fc42)
  URL:        https://systemd.io/

📋 Available Interfaces (4):
  1. io.systemd
  2. io.systemd.Machine
  3. io.systemd.MachineImage
  4. org.varlink.service

🔧 Interface: io.systemd.Machine
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Methods (6):
  📞 Open
    📝 Allocates a pseudo TTY in the container in various modes
    ➡️ name: ?string
      📝 If non-null the name of a machine.
    ➡️ pid: ?ProcessId
      📝 If non-null the PID of a machine. Special value 0 means to take pid of the machine the caller is part of.
    ➡️ allowInteractiveAuthentication: ?bool
      📝 Controls whether interactive authentication (via polkit) shall be allowed. If unspecified defaults to false.
    ➡️ mode: MachineOpenMode
      📝 There are three possible values: 'tty', 'login', and 'shell'. Please see description for each of the modes.
    ➡️ user: ?string
      📝 See description of mode='shell'. Valid only when mode='shell'
    ➡️ path: ?string
      📝 See description of mode='shell'. Valid only when mode='shell'
    ➡️ args: ?[string]
      📝 See description of mode='shell'. Valid only when mode='shell'
    ➡️ environment: ?[string]
      📝 See description of mode='shell'. Valid only when mode='shell'
    ⬅️ ptyFileDescriptor: int
      📝 File descriptor of the allocated pseudo TTY
    ⬅️ ptyPath: string
      📝 Path to the allocated pseudo TTY
  ...

Custom Types (5):
  🏗️ AcquireMetadata (enum)
     📝 A enum field allowing to gracefully get metadata
     Variants:
       • no
       • yes
       • graceful

  🏗️ ProcessId (object)
     📝 An object for referencing UNIX processes
     Fields:
       • pid: int
         📝 Numeric UNIX PID value
       • pidfdId: ?int
         📝 64bit inode number of pidfd if known
  ...

Errors (8):
  ⚠️ NoSuchMachine
    📝 No matching machine currently running
  ⚠️ MachineExists
  ⚠️ NoPrivateNetworking
    📝 Machine does not use private networking
  ...

  📊 Summary:
    • 6 methods
    • 5 custom types
    • 8 error types
```