tiny.acp.Modes

1/// A caller uses this structure to learn which mode the session starts in, such as `plan` or `act`,2/// and how many modes the agent offers. The structure holds the session's current mode id, the3/// number of modes on offer, and a raw copy of the `modes` object from the `session/new` answer.4/// `Client.start` keeps the structure in `Client.modes`, and the value stays empty when the agent5/// reports zero modes. The structure owns `current` and `raw`, and `deinit` frees them.6pub const Modes = struct {7    /// The current mode's id, from `modes.currentModeId`. The slice is owned, and empty by default.8    current: []u8 = &.{},9    /// The number of entries in `modes.availableModes`. The count is 0 by default and when the key10    /// is absent.11    available: usize = 0,12    /// A minified JSON copy of the `modes` object. The slice is owned, and empty by default.13    raw: []u8 = &.{},1415    /// A caller uses this function to free the modes once the caller is done with them. The16    /// function frees the two owned strings with the given allocator and leaves the value17    /// undefined. The call is safe on the default value, which owns zero allocations.18    pub fn deinit(self: *Modes, allocator: Allocator) void {19        if (self.current.len != 0) allocator.free(self.current);20        if (self.raw.len != 0) allocator.free(self.raw);21        self.* = undefined;22    }2324    /// A caller uses this function to read the session's modes from a parsed `session/new`25    /// response, as `Client.start` does. The function reads a parsed JSON-RPC response and returns26    /// the modes in its result. The function returns null when the result lacks a `modes` object or27    /// that object lacks a string `currentModeId`. The function fails with28    /// `error.AgentProtocolError` when the value is a non-object, carries an `error` member, or29    /// lacks an object `result`. The call copies the strings it keeps with the allocator, and the30    /// caller frees them with `deinit`.31    pub fn fromResponse(allocator: Allocator, value: std.json.Value) !?Modes {32        const result = try responseResult(value);33        const modes = json.objectObject(result, "modes") orelse return null;34        const current = json.objectString(modes, "currentModeId") orelse return null;35        const owned_current = try allocator.dupe(u8, current);36        errdefer allocator.free(owned_current);37        const raw = try rawJsonAlloc(allocator, modes);38        errdefer if (raw.len != 0) allocator.free(raw);39        return .{40            .current = owned_current,41            .available = arrayLength(modes, "availableModes"),42            .raw = raw,43        };44    }45};

1pub const Modes = protocol.Modes;