ui/src/controller/consumer_port_types.ts

// Copyright (C) 2019 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.

import {
  IDisableTracingResponse,
  IEnableTracingResponse,
  IFreeBuffersResponse,
  IGetTraceStatsResponse,
  IReadBuffersResponse,
} from '../protos';

export interface Typed {
  type: string;
}

// A type guard that can be used in order to be able to access the property of
// an object in a checked manner.
export function hasProperty<T extends object, P extends string>(
    obj: T, prop: P): obj is T&{[prop in P]: unknown} {
  return obj.hasOwnProperty(prop);
}

export function isTyped(obj: object): obj is Typed {
  return obj.hasOwnProperty('type');
}

export interface ReadBuffersResponse extends Typed, IReadBuffersResponse {}
export interface EnableTracingResponse extends Typed, IEnableTracingResponse {}
export interface GetTraceStatsResponse extends Typed, IGetTraceStatsResponse {}
export interface FreeBuffersResponse extends Typed, IFreeBuffersResponse {}
export interface GetCategoriesResponse extends Typed {}
export interface DisableTracingResponse extends Typed,
                                                IDisableTracingResponse {}

export type ConsumerPortResponse =
    EnableTracingResponse|ReadBuffersResponse|GetTraceStatsResponse|
    GetCategoriesResponse|FreeBuffersResponse|DisableTracingResponse;

export function isReadBuffersResponse(obj: Typed): obj is ReadBuffersResponse {
  return obj.type === 'ReadBuffersResponse';
}

export function isEnableTracingResponse(obj: Typed):
    obj is EnableTracingResponse {
  return obj.type === 'EnableTracingResponse';
}

export function isGetTraceStatsResponse(obj: Typed):
    obj is GetTraceStatsResponse {
  return obj.type === 'GetTraceStatsResponse';
}

export function isFreeBuffersResponse(obj: Typed): obj is FreeBuffersResponse {
  return obj.type === 'FreeBuffersResponse';
}

export function isDisableTracingResponse(obj: Typed):
    obj is DisableTracingResponse {
  return obj.type === 'DisableTracingResponse';
}