Skip to main content

Thread

Struct Thread 

Source
pub struct Thread {
Show 28 fields pub agent_nickname: Option<String>, pub agent_role: Option<String>, pub cli_version: String, pub created_at: i64, pub cwd: AbsolutePathBuf, pub ephemeral: bool, pub forked_from_id: Option<String>, pub git_info: Option<GitInfo>, pub history_mode: Option<ThreadHistoryMode>, pub id: String, pub model: Option<String>, pub model_provider: String, pub name: Option<String>, pub originator: Option<String>, pub parent_thread_id: Option<String>, pub path: Option<String>, pub preview: String, pub project_id: Option<String>, pub reasoning_effort: Option<ReasoningEffort>, pub recency_at: Option<i64>, pub section: Option<ThreadSection>, pub section_entered_at: Option<i64>, pub session_id: String, pub source: SessionSource, pub status: ThreadStatus, pub thread_source: Option<ThreadSource>, pub turns: Vec<Turn>, pub updated_at: i64,
}

Fields§

§agent_nickname: Option<String>

Optional random unique nickname assigned to an AgentControl-spawned sub-agent.

§agent_role: Option<String>

Optional role (agent_role) assigned to an AgentControl-spawned sub-agent.

§cli_version: String

Version of the CLI that created the thread.

§created_at: i64

Unix timestamp (in seconds) when the thread was created.

§cwd: AbsolutePathBuf

Working directory captured for the thread.

§ephemeral: bool

Whether the thread is ephemeral and should not be materialized on disk.

§forked_from_id: Option<String>

Source thread id when this thread was created by forking another thread.

§git_info: Option<GitInfo>

Optional Git metadata captured when the thread was created.

§history_mode: Option<ThreadHistoryMode>

Persisted thread history contract selected when this thread was created.

§id: String

Identifier for this thread. Codex-generated thread IDs are UUIDv7.

§model: Option<String>

Current configured model when loaded, otherwise the latest persisted model. Null when unavailable. This is not per-turn execution telemetry.

§model_provider: String

Model provider used for this thread (for example, ‘openai’).

§name: Option<String>

Optional user-facing thread title.

§originator: Option<String>

Originator recorded when the thread was created, independent of its current client or executor. Null when the recorded originator is unavailable.

§parent_thread_id: Option<String>

The ID of the parent thread. This will only be set if this thread is a subagent.

§path: Option<String>

[UNSTABLE] Path to the thread on disk.

§preview: String

Usually the first user message in the thread, if available.

§project_id: Option<String>

Canonical project assignment owned by app-server, if any.

§reasoning_effort: Option<ReasoningEffort>

Current configured reasoning effort when loaded, otherwise the latest persisted effort. Null when unset or unavailable. This is not per-turn execution telemetry.

§recency_at: Option<i64>

Unix timestamp (in seconds) used for thread recency ordering.

§section: Option<ThreadSection>

The independently persisted section selected for this thread, if any.

§section_entered_at: Option<i64>

Unix timestamp in seconds when the thread entered its current section.

§session_id: String

Session id shared by threads that belong to the same session tree.

§source: SessionSource

Origin of the thread (CLI, VSCode, codex exec, codex app-server, etc.).

§status: ThreadStatus

Current runtime status for the thread.

§thread_source: Option<ThreadSource>

Optional analytics source classification for this thread.

§turns: Vec<Turn>

Only populated on thread/resume, thread/fork, and thread/read (when includeTurns is true) responses. For all other responses and notifications returning a Thread, the turns field will be an empty list.

§updated_at: i64

Unix timestamp (in seconds) when the thread was last updated.

Trait Implementations§

Source§

impl Clone for Thread

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Thread

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Thread

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Thread

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Thread

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Thread

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.