• Home
• com.slack.circuit
• circuit-runtime-jvm
• 0.24.0
• source code
• InternalCircuitApi.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.com.slack.circuit.runtime.InternalCircuitApi.kt Maven / Gradle / Ivy

// Copyright (C) 2023 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package com.slack.circuit.runtime

/**
 * Marks declarations that are **internal** in Circuit API, which means that should not be used
 * outside of `com.slack.circuit`, because their signatures and semantics will change between future
 * releases without any warnings and without providing any migration aids.
 */
@Retention(AnnotationRetention.BINARY)
@Target(
  AnnotationTarget.CLASS,
  AnnotationTarget.FUNCTION,
  AnnotationTarget.TYPEALIAS,
  AnnotationTarget.PROPERTY,
  AnnotationTarget.CONSTRUCTOR,
)
@RequiresOptIn(
  level = RequiresOptIn.Level.ERROR,
  message =
    "This is an internal Circuit API that " +
      "should not be used from outside of com.slack.circuit. No compatibility guarantees are provided. " +
      "It is recommended to report your use-case of internal API to Circuit issue tracker, " +
      "so a stable API could be provided instead",
)
public annotation class InternalCircuitApi