selector.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * 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.
 */
 
#pragma once
 
#include <utility>
 
#include "cuttlefish/host/commands/cvd/cli/command_request.h"
#include "cuttlefish/host/commands/cvd/instances/instance_manager.h"
#include "cuttlefish/host/commands/cvd/instances/local_instance.h"
#include "cuttlefish/host/commands/cvd/instances/local_instance_group.h"
#include "cuttlefish/result/result_type.h"
 
namespace cuttlefish {
namespace selector {
 
InstanceDatabase::Filter BuildFilterFromSelectors(
    const SelectorOptions& selectors);
 
// Selects a single group based on the request's selector options. Asks the user
// to manually choose a single group if multiple groups match the selector
// options and stdin is a terminal.
Result<LocalInstanceGroup> SelectGroup(const InstanceManager& instance_manager,
                                       const CommandRequest& request);
 
// Selects a single instance based on the request's selector options. Asks the
// user to manually choose a single instance if multiple instances match the
// selector options and stdin is a terminal. Also returns the group the
// selected instance belongs to.
Result<std::pair<LocalInstance, LocalInstanceGroup>> SelectInstance(
    const InstanceManager& instance_manager, const CommandRequest& request);
 
// Selects all instances matching the request's selector options.
//
// Returns a vector of pairs, where each pair contains a matching
// LocalInstanceGroup and a vector of its matching LocalInstance member
// instances. Unlike SelectInstance, this method does not fail or prompt the
// user if multiple instances match.
Result<std::vector<std::pair<LocalInstanceGroup, std::vector<LocalInstance>>>>
SelectInstances(const InstanceManager& instance_manager,
                const CommandRequest& request);
 
}  // namespace selector
}  // namespace cuttlefish