Struct Thread 

pub struct Thread {

    pub id: String,
    pub extra: Option<ThreadExtra>,
    pub session_id: String,
    pub forked_from_id: Option<String>,
    pub parent_thread_id: Option<String>,
    pub preview: String,
    pub ephemeral: bool,
    pub history_mode: ThreadHistoryMode,
    pub model_provider: String,
    pub created_at: i64,
    pub updated_at: i64,
    pub recency_at: Option<i64>,
    pub status: ThreadStatus,
    pub path: Option<PathBuf>,
    pub cwd: AbsolutePathBuf,
    pub cli_version: String,
    pub source: SessionSource,
    pub can_accept_direct_input: Option<bool>,
    pub thread_source: Option<ThreadSource>,
    pub agent_nickname: Option<String>,
    pub agent_role: Option<String>,
    pub git_info: Option<GitInfo>,
    pub name: Option<String>,
    pub turns: Vec<Turn>,
}

Fields

id: String

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

extra: Option<ThreadExtra>

Optional implementation-specific thread data.

session_id: String

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

forked_from_id: Option<String>

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

parent_thread_id: Option<String>

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

preview: String

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

ephemeral: bool

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

history_mode: ThreadHistoryMode

Persisted thread history contract selected when this thread was created.

model_provider: String

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

created_at: i64

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

updated_at: i64

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

recency_at: Option<i64>

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

status: ThreadStatus

Current runtime status for the thread.

path: Option<PathBuf>

[UNSTABLE] Path to the thread on disk.

cwd: AbsolutePathBuf

Working directory captured for the thread.

cli_version: String

Version of the CLI that created the thread.

source: SessionSource

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

can_accept_direct_input: Option<bool>

Whether the app server accepts direct turn input for this loaded thread. None means the capability is unavailable, such as for an unloaded stored thread.

thread_source: Option<ThreadSource>

Optional analytics source classification for this thread.

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.

git_info: Option<GitInfo>

Optional Git metadata captured when the thread was created.

name: Option<String>

Optional user-facing thread title.

turns: Vec<Turn>

Only populated on thread/resume, thread/rollback, 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.

Trait Implementations

impl Clone for Thread

fn clone(&self) -> Thread

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Thread

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExperimentalApi for Thread

fn experimental_reason(&self) -> Option<&'static str>

Returns a short reason identifier when an experimental method or field is used, or None when the value is entirely stable.

impl JsonSchema for Thread

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Thread

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Thread

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Thread

impl TS for Thread

type WithoutGenerics = Thread

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Thread

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.