R/s7-elmer_TypeObject.R

Defines functions `.cstr_construct.ellmer::TypeObject.TypeObject` `.cstr_construct.ellmer::TypeObject.type_object` `is_corrupted_ellmer::TypeObject` `.cstr_construct.ellmer::TypeObject` opts_ellmer_TypeObject

Documented in opts_ellmer_TypeObject

#' Constructive options for class 'ellmer::TypeObject`'
#'
#' These options will be used on objects of class 'ellmer::TypeObject`'.
#'
#' Depending on `constructor`, we construct the object as follows:
#' * `"TypeObject"` (default): We build the object using `ellmer::TypeObject()`.
#' * `"next"` : Use the constructor for the next supported class.
#'
#' @param constructor String. Name of the function used to construct the object.
#' @param ... Additional options used by user defined constructors through the `opts` object
#' @return An object of class <constructive_options/constructive_options_ellmer::TypeObject`>
#' @export
opts_ellmer_TypeObject <- function(constructor = c("type_object", "TypeObject", "next"), ...) {
  constructive::.cstr_options("ellmer::TypeObject", constructor = constructor[[1]], ...)
}

#' @exportS3Method constructive::.cstr_construct
`.cstr_construct.ellmer::TypeObject` <- function(x, ...) {
  opts <- list(...)$opts$`ellmer::TypeObject` %||% opts_ellmer_TypeObject()
  if (`is_corrupted_ellmer::TypeObject`(x) || opts$constructor == "next") return(NextMethod())
  UseMethod(".cstr_construct.ellmer::TypeObject", structure(NA, class = opts$constructor))
}

`is_corrupted_ellmer::TypeObject` <- function(x) {
  FALSE
}

#' @export
`.cstr_construct.ellmer::TypeObject.type_object` <- function(x, ...) {
  args <- c(
    list(.description = attr(x, "description")),
    attr(x, "properties"),
    list(
      .required = attr(x, "required"),
      .additional_properties = attr(x, "additional_properties")
    )
  )
  args <- keep_only_non_defaults(args, ellmer::type_object)
  names(args)[names(args) == ".description"] <- ""
  code <- constructive::.cstr_apply(args, fun = "ellmer::type_object", ...)
  constructive::.cstr_repair_attributes(
    x, code, ...,
    idiomatic_class = c("ellmer::TypeObject", "ellmer::Type", "S7_object"),
    ignore = c("S7_class", "description", "required", "additional_properties", "properties")
  )
}

#' @export
`.cstr_construct.ellmer::TypeObject.TypeObject` <- function(x, ...) {
  args <- list(
    description = attr(x, "description"),
    required = attr(x, "required"),
    properties = attr(x, "properties"),
    additional_properties = attr(x, "additional_properties")
  )
  args <- keep_only_non_defaults(args, ellmer::TypeObject)
  names(args)[names(args) == "description"] <- ""
  code <- constructive::.cstr_apply(args, fun = "ellmer::TypeObject", ...)
  constructive::.cstr_repair_attributes(
    x, code, ...,
    idiomatic_class = c("ellmer::TypeObject", "ellmer::Type", "S7_object"),
    ignore = c("S7_class", "description", "required", "additional_properties", "properties")
  )
}

Try the constructive package in your browser

Any scripts or data that you put into this service are public.

constructive documentation built on Nov. 5, 2025, 7:14 p.m.