Packages

Elixir SDK for VertexCache — Secure, Fast, Multi-Index Caching Client

Current section

Files

Jump to
vertexcache_sdk sdk model command_result.ex
Raw

sdk/model/command_result.ex

# ------------------------------------------------------------------------------
# Copyright 2025 to Present, Jason Lam - VertexCache (https://github.com/vertexcache/vertexcache)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ------------------------------------------------------------------------------
defmodule VertexCacheSdk.Model.CommandResult do
@moduledoc """
Represents the result of executing a cache command in the VertexCache SDK.
This struct encapsulates the response status and message returned from the server
after executing a command such as GET, SET, or DEL.
It is used by SDK consumers to inspect whether the command succeeded and to retrieve
associated values or error details. Convenience fields such as `:success` and `:status_message`
help simplify response handling in client logic.
"""
defstruct success: false, status_message: nil
end